19.javadoc中{@link}與@see的簡單使用以及區別

weixin_34249678發表於2017-10-17

寫程式碼的時候,有時候,你需要寫一些註釋,把內容相互關聯起來,方便自己或別人看的時候,可以直接找到你關聯的程式碼類或者啥的。
這個時候,{@link}與@see,這2個javadoc註解就派上用場了,
不管他具體有什麼功能,我們就只管一個,他可以連結程式碼,讓註釋看的更清楚易懂。方便你我他。

@see 標籤允許使用者引用其他類的文件。具體使用方式如下:

@see fully-qualified-classname
@see fully-qualified-classname#方法名稱
@see fully-qualified-classname#屬性名稱

我在使用的時候,發現這個只能單獨一行頂頭寫,如果不頂頭寫就不管用了,沒了連結的效果。
但是,{@link}這個卻可以隨便放。
具體使用方法和上面那個@see是一樣的。
實際效果,看下面的圖吧。

2471034-4bae73edfafdc41b.png
效果圖

相關文章