In writing java, sometimes you need to write notes, and in order to better description, reference need to reference and other code. To give the reader a better experience, javadoc support links jump, which requires use of annotations @see.
@see usage
Annotations @seemay be implemented in the comment links jump. @seeMay be directed to packages, classes, methods, properties.
A complete method is to use this @see package.class#member.
Typical forms for @see package.class#member
If the point in the current class, you can write only after a pound sign.
@see #field
@see #method(Type, Type,...)
@see #method(Type argname, Type argname,...)
@see #constructor(Type, Type,...)
@see #constructor(Type argname, Type argname,...) If the points in the current package, package name may be omitted.
@see Class#field
@see Class#method(Type, Type,...)
@see Class#method(Type argname, Type argname,...)
@see Class#constructor(Type, Type,...)
@see Class#constructor(Type argname, Type argname,...)
@see Class.NestedClass
@see Class If the other packages, the full path needs to point.
@see package.Class#field
@see package.Class#method(Type, Type,...)
@see package.Class#method(Type argname, Type argname,...)
@see package.Class#constructor(Type, Type,...)
@see package.Class#constructor(Type argname, Type argname,...)
@see package.Class.NestedClass
@see package.Class
@see packagereference
@see usage
Annotations @seemay be implemented in the comment links jump. @seeMay be directed to packages, classes, methods, properties.
A complete method is to use this @see package.class#member.
Typical forms for @see package.class#member
If the point in the current class, you can write only after a pound sign.
@see #field
@see #method(Type, Type,...)
@see #method(Type argname, Type argname,...)
@see #constructor(Type, Type,...)
@see #constructor(Type argname, Type argname,...) If the points in the current package, package name may be omitted.
@see Class#field
@see Class#method(Type, Type,...)
@see Class#method(Type argname, Type argname,...)
@see Class#constructor(Type, Type,...)
@see Class#constructor(Type argname, Type argname,...)
@see Class.NestedClass
@see Class If the other packages, the full path needs to point.
@see package.Class#field
@see package.Class#method(Type, Type,...)
@see package.Class#method(Type argname, Type argname,...)
@see package.Class#constructor(Type, Type,...)
@see package.Class#constructor(Type argname, Type argname,...)
@see package.Class.NestedClass
@see package.Class
@see package