Name:
Assignment:
Documentation
□
Each class should include a block comment header containing your name, the date,
and the program/filename.
(Ex:
/* Joe Shmo
January 2, 2007
Scenery.java
*/
)
□
Each class and method should have a javadoc comment with a brief description of
the class or method.
(Ex: /** This method draws
clouds in the sky. */ )
□
Include line comments inside code blocks as appropriate.
(Ex: // Ask user to input the number of
clouds. )
Coding Style
□
Use meaningful, self-documenting names for classes, methods, and variables.
□ Use
standard capitalization -- upper case for class names (Student), mixed case for
methods (calcGPA) and variables (studentID).
□
Indent code between curly braces.
□
Use blank lines to increase readability.
□
Declare variables locally (inside a method) when possible.
□
Do not "hard code" values. Use constants where possible.
Functionality
□ Program compiles.
□ Program runs.
□ Program meets
all requirements.
□ Program is
thoroughly tested and debugged.
Deliverables
□
All java files and class files
are in a folder with your name and the assignment number (Example:
JoeShmo_Asst1), and the folder is copied to the appropriate week in I:\TOstrander\CSci142\Dropbox.
□ This document is printed and filled
out honestly and completely.
□ All code is printed and stapled
behind this document.
|