/**开头，并以*/结束，可以通过 Javadoc 生成 API 帮助文档，Java 帮助文档主要用来说明类、成员变量和方法的功能。@开头，后跟一个指定的名字，有的也以{@开头，以}结束。Javadoc 可以识别的标签如下表所示：| 标签 | 描述 | 示例 |
|---|---|---|
| @author | 标识一个类的作者，一般用于类注释 | @author description |
| @deprecated | 指名一个过期的类或成员，表明该类或方法不建议使用 | @deprecated description |
| {@docRoot} | 指明当前文档根目录的路径 | Directory Path |
| @exception | 可能抛出异常的说明，一般用于方法注释 | @exception exception-name explanation |
| {@inheritDoc} | 从直接父类继承的注释 | Inherits a comment from the immediate surperclass. |
| {@link} | 插入一个到另一个主题的链接 | {@link name text} |
| {@linkplain} | 插入一个到另一个主题的链接，但是该链接显示纯文本字体 | Inserts an in-line link to another topic. |
| @param | 说明一个方法的参数，一般用于方法注释 | @param parameter-name explanation |
| @return | 说明返回值类型，一般用于方法注释，不能出现再构造方法中 | @return explanation |
| @see | 指定一个到另一个主题的链接 | @see anchor |
| @serial | 说明一个序列化属性 | @serial description |
| @serialData | 说明通过 writeObject() 和 writeExternal() 方法写的数据 | @serialData description |
| @serialField | 说明一个 ObjectStreamField 组件 | @serialField name type description |
| @since | 说明从哪个版本起开始有了这个函数 | @since release |
| @throws | 和 @exception 标签一样. | The @throws tag has the same meaning as the @exception tag. |
| {@value} | 显示常量的值，该常量必须是 static 属性。 | Displays the value of a constant, which must be a static field. |
| @version | 指定类的版本，一般用于类注释 | @version info |
{ }包围的标签）为块标签，只能在主要描述（类注释中对该类的详细说明为主要描述）后面的标签部分（如果块标签放在主要描述的前面，则生成 API 帮助文档时会检测不到主要描述）。{ }包围的标签）为内联标签，可以放在主要描述中的任何位置或块标签的注释中。javadoc [options] [packagenames] [sourcefiles]
对格式的说明：javadoc -help就可以看到 Javadoc 的用法和选项（前提是安装配置了JDK），下面列举 Javadoc 命令的常用选项：| 名称 | 说明 |
|---|---|
| -public | 仅显示 public 类和成员 |
| -protected | 显示 protected/public 类和成员（默认值） |
| -package | 显示 package/protected/public 类和成员 |
| -private | 显示所有类和成员 |
| -d <directory> | 输出文件的目标目录 |
| -version | 包含 @version 段 |
| -author | 包含 @author 段 |
| -splitindex | 将索引分为每个字母对应一个文件 |
| -windowtitle <text> | 文档的浏览器窗口标题 |
/**
* @author C语言中文网
* @version jdk1.8.0
*/
public class Test{
/**
* 求输入两个参数范围以内整数的和
* @param n 接收的第一个参数，范围起点
* @param m 接收的第二个参数，范围终点
* @return 两个参数范围以内整数的和
*/
public int add(int n, int m) {
int sum = 0;
for (int i = n; i <= m; i++) {
sum = sum + i;
}
return sum;
}
}
将文件命名为 Test.java，打开 cmd 窗口，输入 javadoc -author -version Test.java命令。如图 1 所示。
图 1 cmd 运行窗口
图 2 Student.html 页面（1）
图 3 Student.html 页面（2）
javadoc -encoding UTF-8 -charset UTF-8 Test.java会解决编码问题。
package test;
/**
* @author C语言中文网
* @version jdk1.8.0
*/
public class Test {
public static void main(String[] args) {
/**
* 这是一个输出语句
*/
System.out.println("C语言中文网Java教程访问地址：http://task.lmcjl.com/java/");
}
}
注意：代码 9~11 行没有放在类、成员变量或方法之前，所以 Javadoc 会忽略这个注释。Export...，如图 4 所示。
图 4
图 5
图 6
图 7
图 8
图 9
<br>，而不是一个回车符；需要分段时，应该使用<p>。
package test;
/**
* @author C语言中文网<br>
* 严长生
* @version 1.8.0<br>
* 1.9.0
*/
public class Test {
public static void main(String[] args) {
System.out.println("C语言中文网Java教程访问地址：http://task.lmcjl.com/java/");
}
}
帮助文档格式如图 10 所示。
图 10
*号及*以前的空格再输入到 HTML 文档。
/**
* first line.
******* second line.
* third line.
*/
first line. <br>
second line. <br>
third line.
*号允许连续使用多个，其效果和使用一个*号一样，但多个*前不能有其他字符分隔，否则分隔符及后面的*号都将作为文档的内容。
本文链接：http://task.lmcjl.com/news/9975.html