eclipse如何爲java項目生成API文檔、JavaDoc

當咱們的項目很大，編寫了不少代碼的時候，就須要生成一個標準的API文檔，讓後續的開發人員，或者合做者能夠清晰的瞭解您方法的使用，那麼如何將本身的項目生成API文檔呢？

一、點擊eclipse的【Project】菜單，選擇【Generate JavaDoc】選項。

二、Next

（1）選擇您要生成JavaDoc的工程

（2）選擇哪些級別的內容生成JavaDoc，默認爲public，若是選擇private則會所有內容都生成。

（3）選擇doc的生成位置，默認爲工程目錄下，建議不要修改。

 

三、繼續下一步

（1）勾選Document Title，而後填寫文檔標題。

（2）點擊【Next】按鈕

四、繼續下一步

（1）選擇使用的jdk版本

（2）點擊【Finish】按鈕

注意這裏加上一個：-encoding UTF-8 -charset UTF-8，能夠解決  編碼GBK的不可映射字符」問題

五、能夠看到控制檯輸出生成javadoc的信息。

六、項目下生成一個【doc】的目錄，裏面存放着javadoc文檔。

七、打開doc目錄，用瀏覽器打開index.html

八、最終能夠看到一個完整的API文檔、javadoc就生成了。