Standard Header

Every program handed in is required to begin in a standard way. This makes it easy to identify the lab assignment and the author. Please follow the example given below:
/*
 * Author:  Iam Student, istudent@fit.edu
 * Course:  CSE 2010, Section 02, Spring 2004
 * Project: Proj 03, Perverse Inverse
 */

If the project is done jointly with other partners, then every file should have the name of all the authors. Each author must be on one line by itself.

If credit for authorship is due to other sources who are not resonsible for submitting the project, then this credit should appear in comments elsewhere in the program.

The header is one part of the documentation that is internal to the program. There should still be other documentation in the file.

Template For the Whole Program

/*
 * Author:  Iam Student, istudent@fit.edu
 * Author:  Iam H. Partner, ipartner@fit.edu
 * Course:  CSE 2010, Section 02, Spring 2004
 * Project: Proj 03, Perverse Inverse
 */

/*
   This class is based on an example by Dr. Know It All (http://www.univ.edu/)
   and was considerably influence by disscussions with O. Student.
*/

import java.text.NumberFormat;

/**
 *  The class <tt>Detection</tt> is a Java application that prints a
 *  table of all purple cows within a 5 mile radius.
 *  @author   Iam Student
 *  @author   Iam H. Partner
 *  @version  2.35, 3 March 2002
 */

public class Detection {

   /**
    *  The main method prints a table.
    */
   public static void main (String[] args) {
      // implementation
   }

   /**
    *    A function to convert a temperature in Celsisus to Fahrenheit.
    *    @param c
    *       a temperture in degrees Celsius greater than -273.16
    *    @return
    *       the temperature c converted to Fahrenheit
    *    @exception IllegalArgumentException
    *       indicates that c is less then the smallest Celsius temperature (-273.14)
    */
   public static double celsisusToFahrenheit (double c) {
      // implementation
   }
}
The use of JavaDoc style documentation is not required.
Ryan Stansifer <ryan@cs.fit.edu>
Last modified: Mon Aug 16 11:25:28 EDT 2004