JavaDoc

 

(1) 注释以“/**”开始，并以“*/”结束，里面可以包含普通文本、HTML 标记和 JavaDoc 标记。

 

/**

 * 生成 DOC 文档

 * @author caibo

 * @version 1.1

 * @since 1.0

 * @see cod.java.DocTest

 *

 */

public class DocTest {

 

public static void main(String[] args) {

}

}

 

(2) javadoc 命令只处理 Java 源文件中在类声明、接口声明、成员方法声明、成员变量及构造方法声明之前的注释，忽略位于其他地方的注释。

 

 

 

 

 

常用的 JavaDoc 标记

 

@version

指定版本信息

 

@since

指定最早出现在哪个版本

 

@author

制定作者

 

@see

生成参考其他 JavaDoc 文档的连接

 

@link

生成参考其他 JavaDoc 文档的连接，它和 @see 标记区别在于，@link 标记能够嵌入到注释语句中，为注释语句的特定词汇生成链接

 

@deprecated

用来标明被注释的类、变量或方法已经不提倡使用，在将来的版本中有可能被废弃

 

@param

描述方法的参数

 

@return

描述方法的返回值

 

@throws

描述方法抛出的异常，指明抛出异常的条件