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. }  

则生成的形式以下：