1. 程式人生 > >如何生成javaDoc文件

如何生成javaDoc文件

如何將自己的專案生成API文件:
方法一:

1.點選eclipse的【Project】選單,選擇【Generate JavaDoc】選項。
2.Next
(1)選擇您要生成JavaDoc的工程

(2)選擇哪些級別的內容生成JavaDoc,預設為public,如果選擇private則會全部內容都生成。

(3)選擇doc的生成位置,預設為工程目錄下,建議不要修改。
3.Next
(1)勾選Document Title,然後填寫文件標題。

(2)點選【Next】按鈕。
4.繼續下一步
(1)選擇使用的jdk版本。

(2)點選【Finish】按鈕。

注意這裡加上一個:-encoding UTF-8 -charset UTF-8,可以解決  編碼GBK的不可對映字元”問題。(注意一下,這裡視情況而定,有的時候不需要新增utf8)
5.可以看到控制檯輸出生成javadoc的資訊

6.專案下生成一個【doc】的目錄,裡面存放著javadoc文件。

7.開啟doc目錄,用瀏覽器開啟index.html。

8.最終可以看到一個完整的API文件、javadoc就生成了。

方法二:

在檔案所在資料夾下開啟cmd,輸入javaDoc 檔名.java,但是這個會在該資料夾下生成javadoc文件,很多,所以視情況而定吧。