Classes Comments
Go to Marquette Home
Introduction to Computer Programming
Replace the <text> with the appropriate description. Do not include the <> brackets.

Class comment headers

/**
* <Description of the class> * References: <With whom you discussed this assignment and what resources you used.> *
* @author <name>
* @version <Created: date, Modified: date - description>
*/

Constructor comment headers

/**
 * <Description of constructor>
 *
 * @param <parameter name> <description>
 */         

Method comment headers

/**
 * <Description of the method>
 *
 * @param <parameter name> <description>
 * @return <description>
 */

Attribute comments

/** <Description of following attribute.> */
private int age;
/** <Description of the next attribute.> */
private double height;

Inline comments

// <inline comment>