在寫java時,有時需要寫注釋,而為了更好的描述,需要引用和參考其他代碼.為了讓閱讀者更好的體驗,javadoc中支持鏈接跳轉,這就需要用到注解@see.
@see用法
注解@see可以在注釋中實現鏈接跳轉.@see可以指向包,類,方法,屬性.
一個完整的使用方法是這樣的@see package.class#member.
Typical forms for @see package.class#member
如果指向的在當前類中,可以只寫井號后面的.
@see #field
@see #method(Type, Type,...)
@see #method(Type argname, Type argname,...)
@see #constructor(Type, Type,...)
@see #constructor(Type argname, Type argname,...) 如果指向的在當前包中,可以省略包名.
@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 如果在其他包中,需要指向全路徑.
@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