| option | purpose | comment context | Hints |
| @param | Description of parameter | method |
use for each parameter separately; give the name of the parameter
first, then the decription: @param newName new name for the printer |
| @return | Description of return value | method | |
| @version | Version of a class | class | Run the documentation tool with the option -version if you want to include the this information in your documentation |
| @author | Author of the class | class | Run the documentation tool with the option -author if you want to include the this information in your documentation |
| @see | reference to other class | class, method | Link to the named class is created |
| @exception | Exception that the method may throw | method |
use for each possible exception separately; give the name of the exception first, then the decription (see @param) |
See class Printer2 for an example.
Try out the documentation tool:
mkdir docu
javadoc -d docu Cell.java
javadoc -d docu Cell.java Printer2.javaCheck the resulting documentation.
| Ulrike Steffens, may 1998 |