天天看點

如何在Eclipse 中生成JavaDoc文檔

  如何在Eclipse 開發工具中生成JavaDoc文檔,在這裡簡要的記錄以下,友善日後查閱。

1 選中需要生成JavaDoc文檔的項目,單擊右鍵---》Export--》Export,選擇Java下的JavaDoc。

      具體如下圖所示:

<a href="http://s2.51cto.com/wyfs02/M00/8C/35/wKioL1hlzLOgbCmYAAAwpcJZW5w360.png-wh_500x0-wm_3-wmp_4-s_353336397.png" target="_blank"></a>

<a href="http://s4.51cto.com/wyfs02/M02/8C/35/wKioL1hlzN7CHsNSAACv7gEKxpo303.png-wh_500x0-wm_3-wmp_4-s_2330160781.png" target="_blank"></a>

2 擇生成文檔的指令,我們選擇jdk目錄下的javadoc.exe。選擇生成Javadoc檔案的目标路徑,預設為項目跟目錄。

3 配置生成檔案的詳細選項。

  這一步可以選擇要生成檔案的具體配置資訊,例如文檔标題、文檔的标簽、是否将項目依賴的包也包含到項目連結中等。具體的配置資訊根據自己的需求選擇即可。

<a href="http://s4.51cto.com/wyfs02/M00/8C/36/wKioL1hlzr7SoKwVAADuFQPNMwY260.png-wh_500x0-wm_3-wmp_4-s_991826189.png" target="_blank"></a>

4 最後一步,配置生成文檔的參數。

  這一步需要配置生成生成文檔的參數,包括虛拟機參數設定、其它額外的指令參數、編譯的jre版本等。這裡需要注意的是如果項目的編碼格式是UTF-8的話,可能生成的文檔會有亂碼或者報錯“編碼GBK的不可映射字元”。這是隻需要在下面配置額外的指令參數“-encoding UTF-8 -charset UTF-8”即可。如下圖所示:

5 成功生成文檔。

 執行完上一步後文檔成功生成。具體資訊如下所示:

本文轉自 烏英達姆 51CTO部落格,原文連結:http://blog.51cto.com/7156680/1887596

繼續閱讀