寫代碼的時候,有時候,你需要寫一些注釋,把內容相互關聯起來,方便自己或別人看的時候,可以直接找到你關聯的代碼類或者啥的。
這個時候,{@link}與@see,這2個javadoc註解就派上用場了,
不管他具體有什麼功能,咱就只管一個,他可以鏈接代碼,讓注釋看的更清楚易懂。方便你我他。
@see 標簽允許用戶引用其他類的文檔。具體使用方式如下:
@see classname
@see fully-qualified-classname
@see fully-qualified-classname#方法名稱
@see fully-qualified-classname#屬性名稱
我在使用的時候,發現這個只能單獨一行頂頭寫,如果不頂頭寫就不管用了,沒了鏈接的效果。
但是,{@link}這個卻可以隨便放。
具體使用方法和上面那個@see是一樣的。
實際效果,看下面的圖
Ⅱ seejava上不了
當你遇到"seejava上不了"的問題時,可以通過以下幾個步驟來解決:
Ⅲ Java中文檔注釋各欄位的含義是什麼例如author表示作者,para表示參數等
常用Java注釋標簽(Java comment
tags)
@author 作者
適用范圍:文件、類、方法
(*多個作者使用多個@author標簽標識,java
doc中顯示按輸入時間順序羅列。)
例:*
@author Leo. Yao
@param 輸入參數的名稱 說明
適用范圍:方法
例:* @param str
the String用來存放輸出信息。
@return 輸出參數說明
適用范圍:方法
例: *
@return <code>true</code>執行成功;
* <code>false</code>執行失敗.
@since
JDK版本
用於標識編譯該文件所需要的JDK環境。
適用范圍:文件、類
例: * @since
JDK1.6
@version 版本號
用於標識注釋對象的版本號
適用范圍:文件、類、方法
例: * @version 1.0
@see 鏈接目標
表示參考。會在java 文檔中生成一個超鏈接,鏈接到參考的類容。使用中的感覺是@see不需要包路徑,對我這種懶人比較喜歡,相對{@link
}這種既要加大括弧,有需要包路徑,我還是選擇偷懶,當然你要是不介意使用import導入要link的類,那就可以達到@see的效果,所以總體來說,還是選擇@see,當然兩個在特殊場合下還是用法不一樣的
用法:
@see
#field
@see #Constructor(Type,
Type...)
@see #Constructor(Type id, Type
id...)
@see #method(Type,
Type,...)
@see #method(Type id, Type,
id...)
@see
Class
@see
Class#field
@see Class#Constructor(Type,
Type...)
@see Class#Constructor(Type id,
Type id)
@see Class#method(Type,
Type,...)
@see Class#method(Type id, Type
id,...)
@see
package.Class
@see
package.Class#field
@see
package.Class#Constructor(Type, Type...)
@see
package.Class#Constructor(Type id, Type id)
@see package.Class#method(Type,
Type,...)
@see package.Class#method(Type
id, Type, id)
@see
package
@throws 異常
標識出方法可能拋出的異常
適用范圍:方法
例: * @throws IOException If an input or output
exception occurred
@deprecated 解釋
標識對象過期
適用范圍:文件、類、方法
@link 鏈接地址
鏈接到一個目標,用法類似@see。但常放在注釋的解釋中形如{@link …}
例:
/**
* @deprecated As of JDK 1.1,
replaced by
* {@link
#setBounds(int,int,int,int)}
*/
Ⅳ java序列化有什麼作用
有利於把一個Java對象變成位元組流的形式傳出去。
有利於從一個位元組流中恢復一個Java對象。
有利於使用的java對象要在分布式中使用或者在rmi遠程調用的網路中使用,實現java序列化介面。