Javadoc

The class itself, and each method in the class, must be documented using javadoc comments. Each method will be preceded by javadoc comments that describe its purpose, input and output, exceptions thrown, where used, and the release it was introduced (and where appropriate, the release it was deprecated).

It is mandated that comments be meaningful and not just stating the obvious. The comments should clearly state the role of a class and how to use it in practice. Similarly for methods. The resulting document from the javadoc comments should provide enough detail so that a programmer knows how to use a class and its methods appropriately.

For example, if a JPO named emxRADProject is associated with a Business Type RADProject which derives from Project, the class would be preceded by the following javadoc comments:

/**
 * This class represents the Business Type RADProject which 
derives from
 * Project. A RADProject is a specialized Project associated with Rapid
 * Application Development? <lots more text goes here>
 * @since AEF 9.0.0
 */
public class ${CLASSPATH} extends ${CLASS:emxProject}
{
:
}

A method belonging to this class might look like:

/**
 * Get the default file format for this RADProject. Default formats are used
 * during file checkin when no explicit format is given.
 *
 * @param context the Matrix <code>Context</code> object
 * @param args not used by this method
 * @return the default format for this RADProject
 * throws exception if the operation fails
 * @since AEF 9.0.0
 */
public String getDefaultFormat(Context context, String [] args) throws Exception
{
:
}