- 首先需要對代碼加上文檔的注釋,比如下面這樣:
-
package wz.learning;
-
-
/**
-
* Title:Person<br>
-
* Description:
-
* Company:SKJP
-
* @author xiashengwang
-
* @version 1.0
-
*/
-
public class PersonWZ {
-
/**
-
* 這是Person的構造函數
-
* @param name Person的名字—
-
*/
-
public PersonWZ(String name){
-
-
}
-
-
/**
-
* 這是讀取方法
-
* @param bookName 書名
-
* @param time 讀書的時間
-
* @return 返回讀書的次數
-
*/
-
public int Read(String bookName, int time){
-
return 0;
-
}
-
}
2,通過eclipse生成最簡單,在項目在項目列表中按右鍵,選擇Export(導出),然后在Export(導出)對話框中選擇java下的javadoc,提交到下一步。
在Javadoc Generation對話框中有兩個地方要注意的:
javadoc command:應該選擇jdk的bin/javadoc.exe
destination:為生成文檔的保存路徑,可自由選擇。
按finish(完成)提交即可開始生成文檔。注意,生成的文檔可能出現亂碼,可以這樣解決:
在Eclipse里 export 選 JavaDoc,在向導的最后一頁的Extra JavaDoc Options 里填上參數即可
比如項目采用的是UTF-8的編碼就填:-encoding UTF-8 -charset UTF-8生成之后的文檔結構如下:
點開其中的index,就可以看到我們的注釋了。