java注释文档

cmd 文档注释

文档注释是用于生成API文档的，API文档主要用于说明类、方法、成员变量的功能

文档注释以斜线后紧跟两个星号（/*）开始，以星号后紧跟一个斜线（/）结束，中间部分全部都是文档注释，会被提取到API文档中去

javadoc工具只处理文档源文件在类、接口、方法、成员变量、构造器和内部类之前的注释，忽略其他地方的注释，javadoc工具默认只处理以public或protected修饰的类、接口、方法、成员变量、构造器和内部类之前的文档注释

javadoc能识别注释中用标记@标识的一些特殊变量，并把doc注释加入它所生成的HTML文件。常用的@标记如下。
• @see：引用其他类。
• @version：版本信息。
• @author：作者信息。
• @param：参数名说明。
• @return：说明。
• @exception：异常说明。
对于有@标记的注释，javadoc在生成有关程序的文档时，会自动地识别它们，并生成相应的文档。

在CMD运行：javadoc -d docDirectory nameOfPackage;
docDirectory 是注释文档的保存路径，nameOfPackage是需要提取注释文档的包的名称

eclipse 文档注释

使用eclipse生成文档（javadoc）主要有三种方法：

1. 在项目列表中按右键，选择Export（导出），然后在Export(导出)对话框中选择java下的javadoc，提交到下一步。
   在Javadoc Generation对话框中有两个地方要注意的：
   javadoc command:应该选择jdk的bin/javadoc.exe
   destination:为生成文档的保存路径，可自由选择。
   按finish(完成)提交即可开始生成文档。

2. 用菜单选择：File->Export(文件－>导出)， 剩下的步骤和第一种方法是一样的。

3. 选中要生成文档的项目，然后用菜单选择，
   Project->Generate Javadoc直接进入Javadoc Generation对话框，剩余的步骤就和第一种方法在Javadoc Generation对话框开始是一样的。

   导出的时候可能会出现因为乱码而导出失败，给 javadoc.exe 加上编码参数就OK。

具体的：

在Eclipse里 export 选 JavaDoc，在向导的最后一页的Extra JavaDoc Options 里填上参数即可

比如项目采用的是UTF－8的编码就填：-encoding UTF-8 -charset UTF-8