Documentation and Submission Guidelines

1. Each submission should be in a folder with an envelope for the disk, which is pasted/taped to the folder in an appropriate orientation so that the disk doesn't fall out.
2. Each disk should be labeled.
3. Each file should have a banner containing the following information
   • author,
   • TA,
   • recitation section,
   • assignment number,
   • brief description about the class,
   • if it is a class with a main method, a description of the algorithm, and
   • description of any input/output.
4. For each method, a documentation banner should contain
   • the name of the method,
   • a description of the method (including the algorithm and information about the return value, if any),
   • parameters, if any, and their descriptions, and
   • information about any input/output.
5. Each conditional statement (if, switch) or loop (for, while) should have
   • a comment with a brief description (later we'll have a more formal description), and
   • one blank line after the statement.
6. Indent carefully so your program is readable.  Remember that your program is not only for the machine to execute, it's also for people to read and understand.

Example

Weather.java -- written by Joohi Lee, TA for COMP114 for the spring of 2001.

Last modified Friday, January 18, 2002 03:54 PM