Programming Projects: Grading Guidelines for CS 310

Profs. Maney, Setia and White

Spring 1999

You will be submitting all source code you have generated to complete the assignment. The following are documentation and formatting guidelines for this code

• (15%) Internal Documentation
  1. Purpose of function explained after ALL function prototypes
  2. Purpose and Meaning of Variables explained You should use mnemonic, self-explanatory identifier/variable Names
  3. Algorithm Description: Somewhere in your submission, you must have a complete description of the problem you are solving, and a high-level description of the solution (kind of data structures, special algorithms) you are using for this task. You must use complete sentences and good grammar.

• (10%) Format - good coding practices followed. All of the following will be looked at:
  1. Nested Indentation for blocks, loops and conditional execution; use uniform indents of about 3 spaces
  2. All function headers highlighted - leave white space generously around the header of each function so it stands out for the reader.
  3. Comments set off from code -use white space to set off the comments for visibility
  4. Vertical Alignment of Comments - don't be messy with comment placement -- a one-line comment should be aligned with the code and surrounded by white space. Multiple one-line comments that serve to explain one point should be either be aligned vertically with each other and either aligned with nearby code or inset some standard amount, to set the comments off from the code. It isn't necessary to have all the comments in your program indented the same amount.
  5. White Space between blocks of code - lines of related code grouped together, separated from non-related code by white space.

• (75%) Algorithm*
  • Correctness of your algorithm implementation typically ~60%
  • Appropriate error checking/ diagnostic messages, Adherence to specifications ~15%