使用javadoc內(nèi)部的文檔注解

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

1、@see

注解@see可以在注釋中實(shí)現(xiàn)鏈接跳轉(zhuǎn).@see可以指向包,類,方法,屬性.

一個(gè)完整的使用方法是這樣的@see package.class#member

  • 如果指向的在當(dāng)前類中,可以只寫(xiě)#號(hào)后面的.
@see #field
@see #method(Type, Type,...)
@see #method(Type argname, Type argname,...)
@see #constructor(Type, Type,...)
@see #constructor(Type argname, Type argname,...)
  • 如果指向的在當(dāng)前包中,可以省略包名.
@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必須頂頭寫(xiě),而{@link 可以任意地方}
{@link StringHttpMessageConverter#readInternal(Class, HttpInputMessage)}
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容