JavaDoc注释命令

在代码中使用一定格式的注释命令，javadoc能构根据这些注释自动生成HTML文档，供使用者查询。

 

javadoc注释命令只能出现于以 /** 开头，以*/ 结尾的注释中，注释中间包含两种内容：

•   嵌入HTML
•   文档标记（以 @ 开头，其前导的 * 号会被忽略）

javadoc只能为public、protected类型的成员处理注释文档，private、friend类型的注释会被忽略(也可以加入-private标记包括private成员)。

 

嵌入HTML

如：

/**

*<pre>

*System.out.println(new Date())

*</pre>

*/

位于一行最开头的 * 号会被忽略，同时忽略的还有 * 号前的空格。不要将<hl>或<hr>这要的标题当做嵌入html使用，因为javadoc会自动生成自己的标题

@see 引用其它类

• @see 类名
• @see 完整类名
• @see 完整类名#方法名

每一格式都会在生成的文档中自动加入一个超链接的"see also"(参见)的条目

类文档标记

除嵌入的HTML以及@see引用外，还可以加入版本及作者的文档标记

1. @version 版本信息（需要在javadoc命令行中加入 -version标记，才会在文档中生成版本信息）
2. @author 作者信息（需要在javadoc命令行中加入 -author标记，才会在文档中生成版本信息）

变量文档标记

 只能包含嵌入的HTML以及@see引用

方法文档标记

除嵌入的HTML以及@see引用外，还可加入参数、返回值、违例的文档标记

1. @param 参数名 说明
2. @return 说明
3. @exception 完整类名 说明
4. @deprecated  （用于指出一些旧功能已由改进过的新功能取代，建议用户不要再使用该功能）