當我們的項目很大,編寫了很多代碼的時候,就需要生成一個標准的API文檔,讓后續的開發人員,或者合作者可以清晰的了解您方法的使用,那么如何將自己的項目生成API文檔呢?
1、點擊eclipse的【Project】菜單,選擇【Generate JavaDoc】選項。
2、Next
(1)選擇您要生成JavaDoc的工程
(2)選擇哪些級別的內容生成JavaDoc,默認為public,如果選擇private則會全部內容都生成。
(3)選擇doc的生成位置,默認為工程目錄下,建議不要修改。
3、繼續下一步
(1)勾選Document Title,然后填寫文檔標題。
(2)點擊【Next】按鈕
4、繼續下一步
(1)選擇使用的jdk版本
(2)點擊【Finish】按鈕
注意這里加上一個:-encoding UTF-8 -charset UTF-8,可以解決 編碼GBK的不可映射字符”問題
5、可以看到控制台輸出生成javadoc的信息。
6、項目下生成一個【doc】的目錄,里面存放着javadoc文檔。
7、打開doc目錄,用瀏覽器打開index.html
8、最終可以看到一個完整的API文檔、javadoc就生成了。