23 lines
596 B
Java
23 lines
596 B
Java
/**
|
|
* This is a class documentation comment. This text shows at the top of the page for this class
|
|
* @author Joe Schmoe
|
|
*/
|
|
public class Doc{
|
|
/**
|
|
* This is a field comment for a variable
|
|
*/
|
|
private String field;
|
|
|
|
/**
|
|
* This is a method comment. It has parameter tags (param), an exception tag (throws),
|
|
* and a return value tag (return).
|
|
*
|
|
* @param num a number with the variable name "num"
|
|
* @throws BadException when something bad happens
|
|
* @return another number
|
|
*/
|
|
public int method(long num) throws BadException{
|
|
//...code here
|
|
}
|
|
}
|