The @see tag provides a reference to additional information. Its most commonly used forms
are shown here:
@see pkg.class#member text
In the first form, anchor is a link to an absolute or relative URL. In the second form,
pkg.class#member specifies the name of the item, and text is the text displayed for that item.
The text parameter is optional, and if not used, then the item specified by pkg.class#member
is displayed. The member name, too, is optional. Thus, you can specify a reference to a
package, class, or interface in addition to a reference to a specific method or field. The name
can be fully qualified or partially qualified. However, the dot that precedes the member name
(if it exists) must be replaced by a hash character.
The @serial tag defines the comment for a default serializable field. It has the following syntax:
Here, description is the comment for that field.
The @serialData tag documents the data written by the writeObject( ) and writeExternal( )
methods. It has the following syntax:
Here, description is the comment for that data.
For a class that implements Serializable, the @serialField tag provides comments for an
ObjectStreamField component. It has the following syntax:
@serialField name type description
Here, name is the name of the field, type is its type, and description is the comment for that field.
The @since tag states that a class or member was introduced in a specific release. It has the
Here, release is a string that designates the release or version in which this feature became
The @throws tag has the same meaning as the @exception tag.
Search WWH :