Packages and Packaging - Java - page 821

Table 21-2. Javadoc keywords

Keyword Use

Author name(s)

@author

Displays text in code font without HTML interpretation

{@code text }

Causes deprecation warning @deprecated

Refers to the root of the generated documentation tree

{@docroot}

Alias for @throws @exception

Inherits documentation from nearest superclass/superinterface {@inheritDoc}

Generates inline link to another class or member

@link

As @link but displays in plain text

@linkplain

Displays text without interpretation

{@literal text }

@param name description Argument name and meaning (methods only)

Return value

@return

Generate Cross-reference link to another class or member

@see

Describes serializable field @serial

Describes order and types of data in serialized form @serialData

Describes serializable field

@serialField

JDK version in which introduced (primarily for Sun use)

@since

Exception class and conditions under which thrown @throws

Displays values of this or another constant field

{@value [ ref ]}

Version identifier

@version