Referencing Sources

Any and all sources, except the course website, MUST be cited in your code.  Do so by placing a comment directly above the portion of your code that was written using the source.  If the source is a website, include the URL to the site.

COPYING AND PASTING CODE IS EXPRESSLY FORBIDDEN!!

Naming Convention

• Use descriptive names for all Classes. Methods and Variables
  • Bad:     x = 1775;
  • Good:  usmcBirthday = 1775;
• Class names should be capitalized
• Use camelCase with lowercase first letter for all method and non-final variable names
• Use ALL CAPS for all constant (aka 'final') variables

General Commenting

The following rules apply throughout the entirety of your work:

• Comment all non-trivial code blocks
• Use comments to describe any variable where a descriptive name is not enough to convey its purpose

Classes

All Classes that you define must have a comment block at the top with the following minimum content:

• Class Name
• Author
• Date
• Description

/** ClassNameHere 
 * 
 * Author:      First Last, email@usna.edu
 * Date:        10 Nov 1775
 * Description: Example...Implementation of iPhone5s calculator user interface
 *              in both portrait and landscape mode. Does not actually 
 *              calculate anything.
 */

Methods

All Class methods that you create must have a comment block using standard Javadoc format, containing:

• a brief description of the method
• input parameters
• return values

/** 
 * Example description.  This method does exactly what we need and nothing more.
 *
 * @param  int     number of times to do it
 * @param  String  what to call it
 * @return boolean value indicating successful completion
 */