使用eclipse生成java doc文档 【转】

一、Javadoc介绍

Javadoc其实平常我们都会见到，JAVASE的API文档就是一个javadoc，很明显，Javadoc的目的是为了能够让外部客户理解我们的代码并使用我们对外的接口。

记住：编写Javadoc的时候只需要对外的接口即可，不需要内部的接口也编写Javadoc注释;

二、Javadoc注释

一般我们的注释形式是：

(1) //

(2) /*     */

而Javadoc注释的形式是：

[java] view plaincopy

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

注意：必须以/**开头；

三、Eclipse生成Javadoc文档

1.编写Javadoc注释

在Eclipse中，如果在某个方法前面输入/**后回车，则会自动生成Javadoc注释的格式，比如：

[java] view plaincopy

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

在以上代码的上一行输入/** 后回车，则会生成如下形式的注释：

[java] view plaincopy

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

2.生成Javadoc注释

如果想生成某个文件或工程的Javadoc文档，则右击后点击Export，然后选择javadoc，即可生成Javadoc；

javadoc command:应该选择jdk的bin/javadoc.exe

（可能会出现编码问题，比如一个浏览器不会出现乱码，而一个浏览器会出现乱码，比如我生成的中文文档，safari是乱码，IE不是乱码）;

四、示例

代码如下：

[java] view plaincopy

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

则生成的形式如下：

以下是我实际操作时遇到的问题：

如果出现错误“错误: 编码GBK的不可映射字符”

在vm option里输入   “-encoding utf-8 -charset utf-8”