Assignments will be handed out in class or posted on the CS Forums.

Source Code

• Modular design mandatory.
• Names of variables and procedures should imply usage.
• Function parameters should be consistently ordered.
• Use standard indentation practices.
• Must be easily read by humans, even the instructor.

Internal documentation

As much as necessary, as little as possible (less == more).

Header commentary should include:

/* file.cpp
  
   CS 270.Bolden.........Compiler version...........Your Name
   Date .................Computer & CPU.............Your email address
  
   Brief description of program and objective.
 *---------------------------------------------------------------------
 */

or something similar, depending upon the programming language.
All variables should be defined, even if self-explanatory.
Every procedure/function needs a one-line (or more) explanation of purpose.

Input Files

Identify any additional files (by filename.ext) that were used.

Output

Should be self-explanatory (reader need not refer to source code).

• Title
• Raw and computed data, displayed in easily readable format.
• Name of programmer, and date of completion.

Turning assignments in for Grading

• Staple all pages together.
• Fold lengthwise, put Name/Class/Date on outside.
• Arrange pages so source appears first, input file next, then output.

Bringing problems to the instructor (or a consultant)

• Eliminate all code except the module containing the error error driver.
• Bring outline/flowchart/pseudocode of program design, indicating where you believe the problem is occurring.
• Bring hard copy of current source code.

Home