當我們的項目很大,編寫了很多代碼的時候,就需要生成一個標准的 API 文檔,讓后續的開發人員,或者合作者可以清晰的了解您方法的使用。
1、點擊 eclipse 的 Project 菜單,選擇 Generate JavaDoc 選項。
2、進入 Generate Javadoc 頁面之后。
Javadoc command:到 jdk 安裝路徑下的 bin 目錄中找到 javadoc.exe 程序。
(1)選擇您要生成 JavaDoc 的工程。
(2)選擇哪些級別的內容生成 JavaDoc,默認為 public,如果選擇 private 則會全部內容都生成。
(3)選擇 doc 的生成位置,默認為工程目錄下,建議不要修改。
3、點擊 Next ,繼續下一步。
(1)勾選 Document Title,然后填寫文檔標題。
4、點擊 Next ,繼續下一步。
(1)選擇使用的 jdk 版本
(2)點擊 Finish 按鈕
注意:如果你項目編碼采用 UTF-8,這里加上一個:-encoding UTF-8 -charset UTF-8,否則生成的網頁中文注釋都是亂碼。
5、 在點擊 Finish 按鈕后,可以看到控制台輸出生成 javadoc 的信息。
6、項目下生成一個 doc 的目錄,里面存放着 javadoc 文檔。
7、查看生成的 Javadoc 幫助文檔。進入到工作空間對應的工程項目下,可以看到有個 doc 文件夾(當然這是默認的輸出目錄,如果你在生成 Javadoc 時設置了其它目錄,可以進入相應的目錄中),點擊 doc 文件夾,會發現 doc 文件夾中有好多 .html 文件,打開 index.html 文件,可以看到生成的 API 文檔,這里面顯示了相應信息,javadoc就生成了。
方式二:
1、打開 eclipse,在需要生成 Javadoc 的項目上右擊鼠標,在彈出來的列表中點擊 "Export" 選項。
2、在彈出來的 "Export" 窗口中,選擇導出的目標,這里選擇 Java 文件夾下的 Javadoc,然后點擊 "Next" 按鈕。
3、其他步驟與上面一致。