Comupter assignment

Dr. Adriana Badulescu Programming Fundamentals II Course Code Convention

Your code should be well-documented. Every line of

code should be preceded by a comment or a Javadoc

comment explaining exactly what that line of code is

doing.

Every class should have a Javadoc comment with the following format: /**

*

* DESCRIPTION

* USAGE

*

* @author [author name]

* @version [version]

*

*/

Every method, should have a Javadoc comment with the following format: /**

*

* DESCRIPTION

*

* @param [argument name] [argument

description]

* @return [description of return]

*

*/

Every other line of code (declaration, initialization, assignment, function call, etc), should be preceded by a regular comment explaining what that line of code is doing. One of the 2 formats: /*

DESCRIPTION – multiple lines

*/

or

// DESCRIPTION – one line

Class

Javadoc

comment

Method

Javadoc

comment

Line of code

regular

comment