Project Analysis and Design - SCJD Exam with J2SE 5 - page 39

Tag Description

@serial

Used to specify whether a class or field that would normally
be serializable should be documented as being Serializable .

{@link reference label }

Generates an inline link to the specified class or method.
Refer to the comments below regarding the @see and @link
tags for special instructions. The label will appear in
monospaced font.

{@linkplain reference label }

Same as the {@link} tag except that the label will appear in
standard font.

{@docRoot}

Points to the base directory (where the index.html file
resides) for your generated Javadoc. This will be correct no
matter how many directories deep this tag is used.

The Javadoc tags for fields are shown in Table 2-6.

Table 2-6. Field Tags

Tag Description

@see

Generates a link to the specified class or method—the link
will appear in a special “See Also” section of the generated
Javadoc.

@since Used to indicate the version number of your package in which

this field first appeared.

@serial

Used to specify whether a class or field that would normally
be serializable should be documented as being Serializable .

@deprecated Used to indicate that a field should no longer be used but still

exists for compatibility reasons. The tag should be followed
by text indicating what field or method the user should use
instead of this field, or “No replacement” if there is no field
with replacement functionality.

{@link reference label }

Generates an inline link to the specified class, method, or
field. The label will appear in monospaced font.

{@linkplain reference label }

Same as the {@link} tag except that the label will appear in
standard font.

{@docRoot}

Points to the base directory (where the index.html file resides)
for your generated Javadoc. This will be correct no matter how
many directories deep this tag is used.

{@value} Displays the value of the constant being specified.

The Javadoc tags for constructors and methods are shown in Table 2-7.