Java注释有三种:
①单行注释:// + 注释内容
②多行注释:/* + 注释内容 + */
③文档注释:/** + 注释内容(有要求) + */
文档注释内容必须为 Javadoc标签。
一行一个,以*开头,加标签和标签内容。
例如:
/**
* 这个类演示了文档注释
* @author 张三
* @version 1.2
*/
Javadoc输出:
javadoc 工具将你 Java 程序的源代码作为输入,输出一些包含你程序注释的HTML文件。
每一个类的信息将在独自的HTML文件里。javadoc 也可以输出继承的树形结构和索引。
Javadoc命令格式:
Javadoc 用法格式如下:
javadoc [options] [packagenames] [sourcefiles]
对格式的说明:
options 表示 Javadoc 命令的选项;
sourcefiles 表示源文件名;
packagenames 表示包名;
注意:
①被注释的文字不会被JVM解释执行。
②多行注释里不允许有多行注释嵌套。
③Javadoc标签: