Javadoc Tags

Javadoc contains many tags to customize the expansion and control of the generation of your documentation. JBuilder generates some of these tags automatically such as @author or @version. Table 8.1 presents a list of many frequently used tags (for a complete list see http://java.sun.com for your specific version of the JDK).

Table 8.1. Javadoc Tags Available within Java Source
Tag Description
@author name Identifies the primary author for a class
[@docroot] Identifies the generated document’s root directory for the generated documentation
@version version Captures the current version of the source code
@param param description Generates the parameter list for a method
@return param Generates information about the return variables ...

Get Borland® JBuilder™ Developer’s Guide now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.