Java幫助文檔的生成

1. 首先需要對代碼加上文檔的注釋，比如下面這樣：
2. package wz.learning;  
3.     
4. /** 
5.  * Title:Person<br> 
6.  * Description: 
7.  * Company:SKJP 
8.  * @author xiashengwang 
9.  * @version 1.0 
10.  */  
11. public class PersonWZ {  
12.     /** 
13.      * 這是Person的構造函數 
14.      * @param name Person的名字— 
15.      */  
16.     public PersonWZ(String name){  
17.             
18.     }  
19.         
20.     /** 
21.      * 這是讀取方法 
22.      * @param bookName 書名 
23.      * @param time 讀書的時間 
24.      * @return 返回讀書的次數 
25.      */  
26.     public int Read(String bookName, int time){  
27.         return 0;  
28.     }  
29. }  

    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，就可以看到我們的注釋了。