javadoc和各種tag使用

javadoc的註釋一定要以/**開頭，*/結尾，如

 

tags：

@see

用法：

@see classname

@see fully-qualified-classname

@see fully-qualified-classname#method-name

功能：創建超鏈接，鏈接到其他類或方法（如果再同一個HTML下則生成超鏈接，如果沒有就不能生成）

出現在文檔的seealso（另請參閱）塊中

@version

用法：

@version version-information

功能：標註版本

出現在文檔的version（版本）塊中

@author

用法：

@author author-information

功能：標註作者

出現在文檔的author（作者）塊中

@since

用法：

@since information

功能：標註從什麼版本，什麼時候開始被使用

出現在文檔的（從以下版本開始）塊中

@param

用法：

@param parameter-name description

功能：標註每個方法的各個參數的用途

出現在方法詳細資料塊中

@return

用法：

@return description

功能：標註方法返回值的含義

出現在方法詳細資料塊中

@throws

用法：

@throws fully-qualified-class-name description

功能：標註方法拋出的異常

出現在方法詳細資料塊中

@deprecated

標註已經廢除的淘汰的，不建議使用的功能

eclipse如何使用javadoc導出文檔：

文件-->導出-->java--->javadoc--->下一步--> 完成

對於javadoc命令的配置，一般在/jdk/bin/javadoc.exe。我的是C:\Program Files\Java\jdk1.7.0_01\bin\javadoc.exe。僅供參考

對於以上標籤的效果測試：

有兩個類，test和Pig(注意test命名不規範)

結果：

 

 

 

 

 另外幾個插入型的標籤：（資料引用:http://www.knowsky.com/363815.html）

{@link package.class#member label}：產生超鏈接

用法：

/** Use the {@link #getComponentAt(int, int) getComponentAt} method. */

{@docRoot}:產生文檔的根路徑

用法：

/**

*see the <a href={@docroot}/copyright.html>copyright</a>

*/

{@inheritDoc}：繼承最近的父類的文檔到本文檔