Java Reference
In-Depth Information
Cross-References in Doc Comments
The
@see
tag and the inline tags
{@link}
,
{@linkplain}
, and
{@value}
all encode a
cross-reference to some other source of documentation, typically to the documenta‐
tion comment for some other type or member.
reference
can take three different forms. If it begins with a quote character, it is
taken to be the name of a topic or some other printed resource and is displayed as
is. If
reference
begins with a < character, it is taken to be an arbitrary HTML
hyperlink that uses the
<a>
tag and the hyperlink is inserted into the output docu‐
mentation as is. This form of the
@see
tag can insert links to other online docu‐
ments, such as a programmer's guide or user's manual.
If
reference
is not a quoted string or a hyperlink, it is expected to have the follow‐
ing form:
feature
[
label
]
In this case,
javadoc
outputs the text specified by
label
and encodes it as a hyper‐
link to the specified
feature
. If
label
is omitted (as it usually is),
javadoc
uses the
name of the specified
feature
instead.
feature
can refer to a package, type, or type member, using one of the following
forms:
pkgname
A reference to the named package. For example:
@see
java
.
lang
.
reflect
pkgname
.
typename
A reference to a class, interface, enumerated type, or annotation type specified
with its full package name. For example:
@see
java
.
util
.
List
typename
A reference to a type specified without its package name. For example:
s
@see
List
javadoc
resolves this reference by searching the current package and the list of
imported classes for a class with this name.
typename
#
methodname
A reference to a named method or constructor within the specified type. For
example:
@see
java
.
io
.
InputStream
#
reset
@see
InputStream
#
close