eclipse 生成 javadoc

文件註釋生成中文doc方法：

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 文件了
-------------------------------------------
如何規範生成JAVADOC幫助文件
1.文字註釋（/** */）也叫歸檔註釋。
    歸檔註釋是一種專用註釋；當它放在類或類成員宣告之前時，javadoc工具可以提取出這些註釋並用它們來生成程式的            HTML文件。歸檔註釋通常入在類、介面、方法及欄位定義之前。
2.文字註釋中的“文件標記”（Doc tags）是一些以“@”開頭的命令;
3.javadoc只能為public（公共）和protected（受保護）成員處理註釋文件。“private”（私有）和“友好”成員（即沒有訪問控制符）的註釋會被忽略，我們看不到任何輸出（也可以用-private標記包括private成員）。

4.類文件標記
類文件可以包括用於版本資訊以及作者姓名的標記。

（1）@version
格式如下：
@version 版本資訊
其中，“版本資訊”代表任何適合作為版本說明的資料。若在javadoc命令列使用了“-version”標記，就會從生成的HTML文件裡提取出版本資訊。

（2） @author
格式如下：
@author 作者資訊
其中，“作者資訊”包括您的姓名、電子函件地址或者其他任何適宜的資料。若在javadoc命令列使用了“-author”標記，就會專門從生成的HTML文件裡提取出作者資訊。
可為一系列作者使用多個這樣的標記，但它們必須連續放置。全部作者資訊會一起存入最終HTML程式碼的單獨一個段落裡。
--------------------------------------
方法文件標記
方法允許使用針對引數、返回值以及異常的文件標記。

（1）@param
格式如下：
@param 引數名 說明
其中，“引數名”是指引數列表內的識別符號，而“說明”代表一些可延續到後續行內的說明文字。一旦遇到一個新文件標記，就認為前一個說明結束。可使用任意數量的說明，每個引數一個。

（2）@return
格式如下：
@return 說明
其中，“說明”是指返回值的含義。它可延續到後面的行內。

（3）@exception
有關“違例”（Exception）的詳細情況，
    @exception 完整類名 說明
    “完整類名”明確指定了一個違例類的名字，它是在其他某個地方定義好的。
    而“說明”（同樣可以延續到下面的行）告訴我們為什麼這種特殊型別的違例會在方法呼叫中出現。

（4） @deprecated該標記的作用是建議使用者不必再使用一種特定的功能，因為未來改版時可能摒棄。
    若將一個方法標記為@deprecated，則使用該方法時會收到編譯器的警告。



       順便提一下在eclipse下，當滑鼠處於類，方法定義行時，按Alt+Shift+J，就可以快速新增文件註釋。至於如何匯出javadoc文件，eclipse環境下，file > export > javadoc > 這裡只要選中你要匯出的*.java檔案即可，要十分注意的是，通常很多人的classpath環境下，帶有 %classpath% 這使javadoc命令無法正確地執行。而提示的出錯資訊通常是IlleagalArgumentException。