Question

Write javadoc comments for each of the 7 static methods you just wrote. They should include: a. A one line summary of what the method does. b. A description of what the program requires to operate and what the result of that operation is.

Answer 1

Answer:

In general, the Javadoc comments are code documentation that offer brief description of a segment of code (e.g. purpose, required input parameter and output)

A sample Javadoc comments is given below:

/**

* Calculate average of a list of number.

* @param myArray -  a list of floating point numbers

*  @return result -  the calculated average of the list of numbers in the array

*/

public static double getAverage(double myArray[] )

{

    // some codes to calculate average

    return result

}

The sample format of the Javadoc above can be applied to document various Java program code.