JDK包含一个很有用的工具叫做javadoc,他是由源文件生成一个HTML文档。通过javadoc生成API的文档，这样即使没有接触过的项目，也可以通过快速浏览javadoc来了解这个项目。
Eclipse生成
- 首先点击File选择Export选项，java->javadoc
- 然后修改use standard doclet 即存放的目录，建议自定义一个文件夹存放
- 如果你是UTF-8的编码方式，则next以后在Extra Javadoc options中输入参数：
-encoding utf-8 -charset utf-8 - 最后Finsh完成以后，即可在工程文件中选择Index查看
注释语法：
注释语法十分简单，通过/**来起头，然后Eclipse后直接帮你生成。注释分别分为类注释，方法注释，域注释，通用注释，包与概述注释。
类注释
类注释在import语句之后，类定义之前。例子：
/**
* Some description about your class.
*
*/
public class Student{
..
}
方法注释
每一个方法注释必须放在所描述的方法之前，除了通用注释以外，还可以使用以下的标记
@param 变量名 对变量的描述，这个描述可以占据多行并能使用HTML标记，一个方法的所有@param标记必须放在一起
@return 对返回值的描述
@throws 异常类名 对异常类抛出的描述
下面是一个示例：
/**
* Count a+b
* @param A the value of A
* @param B the value of B
* @return the sum of A+B
*/
public int Count(int a,int b){
return a+b;
}
域注释
对公有域的注释（通常指静态常量）
通用注释
@author name
将产生一个author条目，说明作者
@version text
这个标记将产生一个version条目，这里的文慕是对当前版本的描述，适用于所有的文档注释
@since text
这里的text是对引入特性的版本描述，如@since version 1.01
@see 引用
这个标记将在"see also"部分增加一个超级链接。这里的引用可以是下面几种情形之一：
1.package.class#feature label
这种情况是最常见的，提供类，方法或者变量的名字就在文档中插入一个超链接
如： @see package.Number#Count(int,int)
将建立一个连接到package.Number类中的Count(int,int)方法中，需要注意的是，j一定要使用#来区别类类名与方法名或变量名，而不是“.”
<a href="URL">label<a>
这个可以超链到URL，通过指定一个标签作为链接锚
"text"
这个将直接显示在see also部分中
总结
至此大部分实用的javadoc标记就已经介绍完了