Commenting Tips

All objects and methods must be clearly commented. These comments will create Java Docs style APIs.

Objects:

/**
* Write a description of class here.
*
* @author (your name)
* @version (a version number or a date)
*/

Methods:

/**
* An example of a method - replace this comment with your own that explains the purpose * of the method.
*
* @param y a sample parameter for a method
* @return the sum of x and y
*/

See the API this produces: API

See the source code for the Card object: Card.java

©2005 C. Whittington