Java Documentation Standards

All source code submitted to Dr. Taylor should follow the Java Coding Standard developed in the Software Development Laboratory.

The beginning C-style (/*...*/) comments must contain:

• The course and section for which the class was written.
• The term in which the course was taken.
• The assignment for which the class was written.
• The original author.
• The date it was originally written.

/* 
 * Course: SE1020-003
 * Term: Winter 2008-2009
 * Assignment: Lab 1
 * Author: Chris Taylor
 * Date: 12/08/08
 */

Please see the sample at the Complex class implementation at the end of my User Defined Classes Tutorial for an example of how to do javadoc comments.