（转）JDK工具-javadoc命令

背景：最近在学习java基础知识，看到文档注释部分，一种是在dos命令下生成api文件，另一种是在eclipse下生成api文件。dos方式在《疯狂java讲义》中有详细的说明，eclipse方式因为平时用的比较多，所以需要进行总结。

1 讲解

1.1 基础

Javadoc是Oracle公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档。

项目-->右键菜单Export-->Java下Javadoc-->next：
javadoc command:就是要调用的javadoc.exe，不用修改，eclipse会找到的；
use standard doclet:就是要生成到的目录，自定义一个文件夹作为存放目录[不然一大堆]；
默认即可next-->再next-->
【注意注意】此时如果项目采用的是UTF-8编码，Extra Javadoc options下需要输入设定参数，否则生成的网页中文注释都是乱码。

-encoding utf-8 -charset utf-8

最后Finish完成。

在工程的doc 目录中，就有Javadoc 文档了

一般注释解释：

@author 作者名   
@version 版本标识   
@parameter 参数及其意义 
@since 最早使用该方法/类/接口的JDK版本   
@return 返回值 
@throws 异常类及抛出条件 
@deprecated 引起不推荐使用的警告   
@see reference 
@override 重写

参考接口和类：

package test;
/**
 * 测试接口
 * @author java小强
 * @version 0.0.1
 */
public interface TestFace {
}

类：

package test;
/**
 * 测试文档输出<b>大写测试</b><br>
 * 已经换行<br>
 * Class <code>JavaBlogTest</code> is by java小强
 * 
 * @author java小强
 * @version 0.0.1
 * @since 1.5
 */
public class JavaBlogTest implements TestFace{
 /** 拼接到参数后返回 */
 private String BACK = "_BACK";
 /**
  * 获得新生
  * @param oldStr 老参数
  * @return 返回参数
  * @exception IndexOutOfBoundsException if <code>oldStr</code> is null
  */
 public String getStr(String oldStr){
  return oldStr + BACK;
 }
}

操作步骤和生成结果截图：

 1.2 实战

技术文档是项目的重要组成部分，Javadoc则是Java技术文档的基础之一。Javadoc为Java代码生成一组便于使用的API文档，作为沟通工具，这些文档可提供有益的帮助，使团队成员理解其他成员正在进行的工作。 

当然，要获得良好的Javadoc文档，要求源代码中有精心编写的有意义的注释，对任何工具而言，这都是苛刻的要求。这不是本文的重点内容。 

本文将具体讲述使用Eclipse开发工具导出项目的Javadoc文档的步骤和常见的问题。 

1. Eclipse导出文档操作步骤 

1. 根据Javadoc文档的说明标准，对项目中的类、接口等文件精心编写注释。 

2. 选中要生成javadoc的项目，右键->Export(导出)。选择Java->javadoc，点击Next>。 

     

3. 分别选择如下选项，点击Next。 

javadoc command:设置javadoc命令的路径。 

select types for which javadoc will be generated:选择需要生成的项目 

Create javadoc for members with visibility：选择生成文档的类和方法的访问范围。 

Destination:选择生成文档的目标目录。 

       

4. 在Documenet title中填入生成文档的名称，其它选择默认，点击Next。 

      

5. 在VM options中填入-encoding utf-8 -charset utf-8，具体的编码方式，根据你的项目 

的编码方式决定。点击Finish。 

注意：如果编码方式不对，会出现编码错误报错！！！ 

        

6. 然后，有Eclipse生成文档。 

          

2. 可能出现的错误集锦 

1. 在导出Android项目的时候，出现android.os包不存在等报错时，是由于项目无法 

找到Android的jar包而引起的。项目邮件->property->Java build path->Order and Export，勾选其中导入的包，就可以解决此问题。 

2. 在生成文档的时候，出现GBK编码无效的报错时，是由于Java默认使用GBK编码， 

与你的项目冲突导致的，在导出中文文档的时候这个问题尤为突出，在生成文档想到中，注意在VM options中填入-encoding utf-8 -charset utf-8。可以解决此问题。