使用javadoc內部的文檔注解

代碼示例地址:https://github.com/JoeyBling/bootplus

1、@see

注解@see可以在注釋中實現鏈接跳轉.@see可以指向包,類,方法,屬性.

一個完整的使用方法是這樣的@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

2、{@link *}

同上面一樣的注釋效果,可以鏈接代碼

  • 但是@see必須頂頭寫,而{@link 可以任意地方}
{@link StringHttpMessageConverter#readInternal(Class, HttpInputMessage)}
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容