这篇文章由http://www.Sina.com/www.234 yp.com统一发表。 感谢您与Java教程www.234 yp.com/article/198092.html的合作。
泉州SEOJava支持三种类型的注释：单行注释、多行注释和文档注释。 注释以/**开始，以*/结束。 可以从主要用于描述类、成员变量和方法功能的Javadoc生成API帮助文档。
文档注释仅放置在类、接口、成员变量和方法之前。 因为Javadoc只处理这些位置的文档注释，而忽略其他位置的文档注释。
Javadoc是Sun提供的工具，它从程序源代码中提取类、方法和成员等注释，并与源代码配套创建API帮助文档。 这意味着，如果在编写程序时使用特定的标签进行注释，则在程序创建完成后，Javadoc将为程序创建API帮助文档。
API帮助文档相当于产品说明书，但由于说明书只介绍了用户可以使用的部分，因此Javadoc默认只提取public，protected的修饰部分。 要提取由private限定的部分，必须使用-private。 Javadoc标签Javadoc工具标识文档注释中的特定标签，通常以@开始，后跟指定名称，或以{@开始。 Javadoc可以识别的标签如下表所示。
标签说明示例@author标识类的创建者。 类注释@author description @deprecated通常用于指定过期的类或成员。 表示类或方法使用@ deprecated description { @ docroot }时，当前文档根目录的路径Directory Path @exception可能会引发异常。 方法注释@ exception exception-name explanation { @ inherit doc }从直接父类继承的注释inheritsacommentfromtheimmediatesurperclass 插入指向常用于的其他主题的链接{@link name text} {@linkplain}插入指向其他主题的链接，但使用纯文本字体inserts anin-linelinktoanotherton 常用于在方法注释@ param parameter-name explanation @ return中说明返回类型，常用于方法注释。 在重建方法中@return explanation @see不能指定指向其他主题的链接@see anchor @serial说明序列化属性@serial description @serialData说明是writed 用明了的方法写的数据@ serialdatadescription @ serial field， 与说明ObjectStreamField组件@ serialfieldnametypedescription @ since从哪个版本开始具有此函数@sincerelelection的@exception标签一样， the @ throwstaghasthesamemeaningasthe @ exception tag.{ @ value }表示常量的值，该常量必须是静态属性。 Displays the value of a constant，whichmustbeastaticfield.@ version指定类的版本，一般用于类注释@version info
以下两种标签格式的说明：
未用@tag格式标记{ }括起来的标记(是块标记，只能出现在主要说明(类注释中对该类的详细说明是主要说明)之后的标记部分)位于主要说明之前时，API帮助文档的用{@tag}格式的标记{ }括起来的标记是内联标记，可以放置在主要说明中的任意位置或块标记的注释中。
Javadoc标记注意事项：
Javadoc标记必须从一行的开头开始。 如果不开始，将被视为普通文本。 一般来说，同名的标签在一起。 Javadoc标签区分大小写，而代码中大小写错误的标签不会出现编译错误，但在生成API帮助文档时找不到注释内容。 Javadoc命令Javadoc的使用格式如下。
javadoc [ options ] [ package names ] [ source files ]
格式说明：
options表示Javadoc命令的选项； packagenames表示包名称，sourcefiles表示源文件名称。
如果已安装并配置了JDK，请在cmd )命令提示符下键入Javadoc -help以显示Javadoc的使用方法和选项。 以下是javadoc命令的常规选项：
名称说明-public仅显示public类和成员-protected显示p
rotected/public 类和成员（默认值） -package 显示 package/protected/public 类和成员 -private 显示所有类和成员 -d <directory> 输出文件的目标目录 -version 包含 @version 段 -author 包含 @author 段 -splitindex 将索引分为每个字母对应一个文件 -windowtitle <text> 文档的浏览器窗口标题 DOS命令生成API帮助文档新建一个空白记事本，输入下列代码：
/*** @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 运行窗口
打开 Test.java 文件存储的位置，会发现多出了一个 Test.html 文档。打开文档，文档页面如图 2 和图 3 所示。
图 2 Student.html 页面（1）
图 3 Student.html 页面（2）
注意：以上没有考虑编码格式的问题，注释中有汉字可能会乱码。使用javadoc -encoding UTF-8 -charset UTF-8 Test.java会解决编码问题。
1）在 MyEclipse 中新建一个 Test 类，代码如下：
package test;/*** @author C语言中文网* @version jdk1.8.0*/public class Test { public static void main(String[] args) { /** * 这是一个输出语句 */ System.out.println("C语言中文网Java教程访问地址：java/"); }}注意：代码 9~11 行没有放在类、成员变量或方法之前，所以 Javadoc 会忽略这个注释。
2）在项目名处单击鼠标右键，然后选择Export...，如图 4 所示。
图 4
3）在弹出窗口中选择 Java 文件夹，点击 Java 文件夹下面的 Javadoc，然后点击“Next”，如图 5 所示。
图 5
4）选择你要生成 Javadoc 的项目，并更改你想保存的 API 帮助文档地址（默认为工程目录下，建议不要修改）。点击“Finish”，如图 6 所示。
图 6
5）点击“Finish”之后会问是否更新 Javadoc 文件的位置，只需要点击“Yes To All”即可，如图 7 所示。
图 7
6）这时可以看到控制台输出生成 Javadoc 的信息，如图 8 所示。
图 8
7）打开保存的文件夹，找到 Test.html 文件并打开，如图 9 所示。
图 9
以上就是使用 MyEclipse 简单建立一个 API 帮助文档的过程。
在编写文档注释的过程中，有时需要添加 HTML 标签，比如：需要换行时，应该使用<br>，而不是一个回车符；需要分段时，应该使用<p>。
例如把上面 Test 类改为以下代码：
帮助文档格式如图 10 所示。
图 10
Javadoc 并不是将代码中的文档注释直接复制到帮助文档的 HTML 文件中，而是读取每一行后，删除前面的*号及*以前的空格再输入到 HTML 文档。
/**
* first line.
******* second line.
* third line.
*/
编译输出后的 HTML 源码如下所示。
first line. <br>
second line. <br>
third line.
注释前面的*号允许连续使用多个，其效果和使用一个*号一样，但多个*前不能有其他字符分隔，否则分隔符及后面的*号都将作为文档的内容。