Java生成javadoc

1、Javadoc介紹

Javadoc其實日常咱們都會見到，JAVASE的API文檔就是一個javadoc，很明顯，Javadoc的目的是爲了可以讓外部客戶理解咱們的代碼並使用咱們對外的接口。

記住：編寫Javadoc的時候只須要對外的接口便可，不須要內部的接口也編寫Javadoc註釋;

2、Javadoc註釋

通常咱們的註釋形式是：

(1) //

(2) /*     */

而Javadoc註釋的形式是：

/** 

1.  *  

2.  * @return  

3.  */  

注意：必須以/**開頭；

3、Eclipse生成Javadoc文檔

1.編寫Javadoc註釋

在Eclipse中，若是在某個方法前面輸入/**後回車，則會自動生成Javadoc註釋的格式，好比：

[public void setAge(int age) {  

1.     this.age = age;  

2. }  

在以上代碼的上一行輸入/** 後回車，則會生成以下形式的註釋：

/** 

1.  *  

2.  * @param age  

3.  */  

4. public void setAge(int age) {  

5.     this.age = age;  

6. }  

2.生成Javadoc註釋

若是想生成某個文件或工程的Javadoc文檔，則右擊後點擊Export，而後選擇javadoc，便可生成Javadoc；

（可能會出現編碼問題，好比一個瀏覽器不會出現亂碼，而一個瀏覽器會出現亂碼，好比我生成的中文文檔，safari是亂碼，IE不是亂碼）;

4、示例

代碼以下：

 * 建立Person對象的另外一種方式 

1.  * @param name 姓名 

2.  * @param age 年齡 

3.  * @return Person對象 

4.  */  

5. public static Person getInstance(String name,int age){  

6.     return new Person(name,age);  

7. }  

則生成的形式以下：