javadoc的使用及eclipse產生

1.Eclipse文檔注釋產生方法：

1.項目-->右鍵菜單Export-->Java下Javadoc-->next：
<1>javadoc command:就是要調用的javadoc.exe，不用修改，eclipse會找到的；
<2>use standard doclet:就是要產生到的目錄，自訂一個檔案夾作為存放目錄[不然一大堆]；
<3>預設即可next-->再next-->
<4>【注意注意】此時如果項目採用的是UTF-8編碼，Extra Javadoc options下需要輸入設定參數：-encoding utf-8 -charset utf-8否則產生的網頁中文注釋都是亂碼。
<5>最後Finish完成。
在工程的doc 目錄中，就有Javadoc 文檔了

 

---------------------------------------------風騷的分割線------------------------------------------------

 

2.javadoc的使用說明：

 

如何規範產生JAVADOC協助文檔

1.”文本注釋“=也叫歸檔注釋。

"/** */"歸檔注釋是專用注釋；類或類成員聲明之前;javadoc工具提取它們來產生HTML文檔。歸檔注釋:1.類/介面/方法/欄位生命之前。

 

2.“文檔標記”

//以"@"開頭的命令;1.類文檔標記  ----包括:版本資訊/作者。（1）@version 版本資訊:        從產生的HTML提版本資訊。        對應"javadoc -version"（2）@author 作者資訊        可包括：姓名/email。        對應 "javadoc -author"--------------------------------------2.方法文檔標記  ----參數/傳回值/異常。（1）@param 參數名 說明（2）@return 說明 指傳回值的含義。（3）@exception 完整類名 說明    “完整類名”定義好的異常類名。（4）@deprecated  不建議使用，將來可能擯棄。

 

3.只為 "public/protected" 處理注釋文檔。

"private"和"default" 注釋會被忽略，看不到輸出

可用-private標記包括private。

---------------------------------------------風騷的分割線------------------------------------------------

3.文檔注釋快速鍵   

eclipse下，當滑鼠處於類，方法定義行時，按Alt+Shift+J，快速添加文檔注釋。

設定預設格式：file > export > javadoc >