XML by Example

Figure A.3: Javadoc documentation

Javadoc recognizes paragraphs starting with the @ character as special

paragraphs. The most common ones are

•

@version States the application version

• @author States the name of the author (you can have multiple

@author paragraphs)

•

@param Documents a method parameter (you can have multiple

@param paragraphs)

• @return Documents the value returned by a method

• @exception Documents the exception that a method can throw

2. There is an alternative form for short comments, also derived from

C++. Anything after the

// characters until the end of the line is a

comment, as in

// we don’t want to overwrite a file by mistake

Exception ...