一、注释的作用

• 提高了代码的阅读性；调试程序的重要方法。
• 注释是一个程序员必须具备的良好的编程习惯。
• 将自己的思想通过注释先整理出来，再用代码去体现。

二、 java 注释类型

Java注释分为三种类型：

• 单行注释

• 多行注释

• 文档注释（ Java特有 ）

1、单行注释

格式：

2、多行注释

格式：

/*这里是多行注释的内容

可以写好多行*/

单行注释和多行注释的内容不参与编译，换句话说，注释以后生成的.class 字节码 文件中不包含注释的内容。

注意 ： 多行注释不能嵌套使用

3、文档注释（Java特有）

格式：

/**

@author 指定Java程序的作者

@version 指定源文件的版本

*/

注释内容可以被 JDK 提供的工具 javadoc 所解析，生成一套以网页文件形式体现的该程序的说明文档。

操作方式：

先命令行进入Java代码所在目录，

然后在命令行输入： javadoc -d MyHelloJavaDoc -author -version HelloJava.java

MyHelloJavaDoc 是自己起的一个名字，随便起一个都可以

HelloJava.java 是自己的Java代码名字

输入命令后，会出现如下信息，表明操作成功

这时候会在Java源代码所在文件夹生成一个刚刚自己命名的文件夹

打开文件夹，双击 index.html 文件，就会打开网页，出现我们注释的作者和版本信息

如果出现以下报错信息，则说明需要在Java代码的 class 类前面加上 public ，加上后便不会报错。