Java生成javadoc

一、Javadoc介紹

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

記住：編寫Javadoc的時候只需要對外的接口即可，不需要內部的接口也編寫Javadoc注釋;

二、Javadoc注釋

一般我們的注釋形式是：

(1) //

(2) /*     */

而Javadoc注釋的形式是：

[java]

1. /** 
2.  *  
3.  * @return 
4.  */  

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

三、Eclipse生成Javadoc文檔

1.編寫Javadoc注釋

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

[java]

1. public void setAge(int age) {  
2.     this.age = age;  
3. }  

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

[java]

1. /** 
2.  *  
3.  * @param age  
4.  */  
5. public void setAge(int age) {  
6.     this.age = age;  
7. }  

/** * * @param age */ public void setAge(int age) { this.age = age; }

2.生成Javadoc注釋

如果想生成某個文件或工程的Javadoc文檔，則右擊後點擊Export，然後選擇javadoc，即可生成Javadoc；

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

四、示例

代碼如下：

[java]

1. /** 
2.  * 創建Person對象的另一種方式 
3.  * @param name 姓名 
4.  * @param age 年齡 
5.  * @return Person對象 
6.  */  
7. public static Person getInstance(String name,int age){  
8.     return new Person(name,age);  
9. }  

則生成的形式如下：