Project Document Requirements

• Use 8.5x11 paper, written in portrait orientation.
• Put your name and the project number at the top of the first sheet.
• Staple the sheets together in the upper left corner.

• No green-line paper.
• No fan-fold paper.
• No dot-matrix printers.
• No paper clips.

Standards for C Programs

• Keep all lines in under 70 characters in length.
• Put the opening curly-brace of a function definition on the same line as the function name, and put the matching closing brace on its own separate line, matching the indentation of the function header.
• Indent each declaration and statement in a function definition to a consistent level.
• Break multi-line declarations and statements at operators with low precedence, commas, or other natural separators, and indent subsequent lines of the declaration or statement to make the statement appear to be a single unit and to visually connect its related component parts.
• Use capitalLetters to mark componentWords in compoundEntityNames. Choose choose descriptive names for variables.
• Avoid mixing literals and conversion specifiers in the format string of print commands.
• Use initialization in declaration statements only for constant variables.
• Lay out if-statements like this:

           if ( Boolean Expression ) {
             statements, consistently indented
           } else {
             statements, consistently indented
           }          
  

• Lay out while-statements like this:

           while ( Boolean Expression ) {
             statements, consistently indented
           }
  

• Lay out for-statements like this:

           for ( loop control expressions ) {
             statements, consistently indented
           }
  

• Implement modules in three files, named as follows:

  moduleName.c

  contains definitions public and private entities of module

  imports both moduleName.h and moduleNamePrivate.h

  moduleName.h

  contains declarations of public entities of module, each preceded by a brief description of the entity

  moduleNamePrivate.h

  contains declarations of private entities of module, each preceded by a brief description of the entity

  may be omitted if the module defines no private entities
  

  Other modules using this one import moduleName.h
  

Standards for Session Transcripts