Java 和其他高级语言一样，也支持在源文件（*.java）中添加注释（Comment）。
注释的作用是对源程序进行解释说明，适当的使用注释可以增强源程序的可读性和可维护性。
注释内容在编译时会被忽略，因而不会导致编译后的字节码文件（*.class）变得臃肿。
Java 支持三种注释：
第一种：单行注释，使用 // 开头。该种注释在使用 JDK 中提供的文档化工具 javadoc 时，不会被自动提取，生成软件说明文档。
第二种：普通多行注释，使用 /* 开头，*/ 结束。该种注释可以跨行，适合内容较长的注释。但是，该种注释在使用 JDK 中提供的文档化工具 javadoc 时，不会被自动提取，生成软件说明文档。
第三种：JavaDoc 类型的多行注释，使用 /** 开头，*/ 结束。该种注释可以使用 JDK 中提供的文档化工具 javadoc 将该注释的内容提取出来自动生成软件说明文档。
示例1：使用注释
/**
* 这是一个用于测试的测试类
* @author hxstrive.com 2022/3/20
*/
public class CommentsDemo {
/*
普通多行注释，姓名
*/
private String name;
/**
* 多行注释
* 返回 name 属性的值
* @return 返回用户名
*/
public String getName() {
// 单行注释，直接返回姓名
return this.name;
}
}接下来我们可以使用 JDK 提供的文档化工具 javadoc 来提取 CommentsDemo.java 中的注释内容。命令如下：
C:\Users\Administrator\Desktop>javadoc CommentsDemo.java 正在加载源文件CommentsDemo.java... 正在构造 Javadoc 信息... 标准 Doclet 版本 1.8.0_45 正在构建所有程序包和类的树... 正在生成.\CommentsDemo.html... 正在生成.\package-frame.html... 正在生成.\package-summary.html... 正在生成.\package-tree.html... 正在生成.\constant-values.html... 正在构建所有程序包和类的索引... 正在生成.\overview-tree.html... 正在生成.\index-all.html... 正在生成.\deprecated-list.html... 正在构建所有类的索引... 正在生成.\allclasses-frame.html... 正在生成.\allclasses-noframe.html... 正在生成.\index.html... 正在生成.\help-doc.html...
默认情况下，将在当前目录下面生成 Java Doc 文档，直接使用浏览器打开 index.html 文件，如下图：
更多关于 javadoc 的用法，将在后续章节详细介绍。
川公网安备51010802032098
