Projects Page‎ > ‎

Commenting

Header Comment
/**
 * Curtis HS
 * AP-CS, p-5, 12/1/14
 * This program will...
 *
 * @author  Troy Hashagen
 * @version Dec 2014
 */


Method Comment

If no parameters or return

/**
 * This method...
 *
 */

If parameters but no return 

/**
 * This method takes in two values and prints the median.
 * @param  x  The first value
 * @param  y  The second value
 */

If parameters & return

/**
 * This method takes in two values and finds the median.
 *
 * @param  x  The first value
 * @param  y  The second value
 * @return  the median of the two values
 */


/**
 * This method...
 *
 * @param  <variable name> purpose of variable
 * @param  ...
 * @return  what return value represents 
 */



Comments