Java Reference
In-Depth Information
@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.
@see
The @see tag provides a reference to additional information. Two commonly used forms
are shown here:
@see anchor
@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 pre-
cedes the member name (if it exists) must be replaced by a hash character.
@serial
The @serial tag defines the comment for a default serializable field. It has the following
syntax:
@serial description
Here, description is the comment for that field.
@serialData
The @serialData tag documents the data written by the writeObject( ) and writeExtern-
al( ) methods. It has the following syntax:
@serialData description
Here, description is the comment for that data.
Search WWH ::




Custom Search