{@docRoot} - @exception - {@inheritDoc} - {@link} - {@linkplain} - {@literal} - @param - @return - Java SE 6

{@docRoot}

{@docRoot} specifies the path to the root directory of the current documentation.

@exception

The @exception tag describes an exception to a method. It has the following syntax:

@exception exception-name explanation

Here, the fully qualified name of the exception is specified by exception-name, and explanation

is a string that describes how the exception can occur. The @exception tag can only be used

in documentation for a method.

{@inheritDoc}

This tag inherits a comment from the immediate superclass.

{@link}

The {@link} tag provides an in-line link to additional information. It has the following syntax:

{@link pkg.class#member text}

Here, pkg.class#member specifies the name of a class or method to which a link is added, and

text is the string that is displayed.

{@linkplain}

Inserts an in-line link to another topic. The link is displayed in plain-text font. Otherwise,

it is similar to {@link}.

{@literal}

The {@literal} tag enables you to embed text into a comment. That text is then displayed as is,

without any further processing, such as HTML rendering. It has the following syntax:

{@literal description}

Here, description is the text that is embedded.

@param

The @param tag documents a parameter to a method or a type parameter to a class or

interface. It has the following syntax:

@param parameter-name explanation

Here, parameter-name specifies the name of a parameter. The meaning of that parameter is

described by explanation. The @param tag can be used only in documentation for a method

or constructor, or a generic class or interface.

@return

The @return tag describes the return value of a method. It has the following syntax:

@return explanation

Here, explanation describes the type and meaning of the value returned by a method. The

@return tag can be used only in documentation for a method.

Search WWH :

Custom Search