3、Java注释（单行注释，多行注释，文档注释）（超详细版本）

Java注释

注意：被注释的文字，不会被JVM（Java虚拟机）解释执行，简单来说，就是里面的语句在运行时不会执行
1）单行注释：//

public class Hello {
    public static void main(String []args){
        //两个数求和
        int a = 1;
        int b = 1;

        //核心步骤
        int sum = a + b;
        System.out.println("结果:"+sum);
    }
}

2）多行注释：/**/

（多行注释里面不允许有多行注释的嵌套）

 
3）文档注释：以/**开始， 以*/结束
注释内容可以被JDK提供的工具javadoc所解析，生成一套以网页文件形式（.html）体现的该程序的说明文档，只放在类、接口、成员变量、方法之前（因为Javadoc只处理这些地方的文档注释，而忽略其他地方的文档注释）

Javadoc工具软件识别以下标签：

具体操作步骤：
①编写程序，并保存到相应位置（此次我只写了个很简单的程序进行讲解，保存的地址是：E:\code\JavaLearn\src\Hello.java）

/**
 * @author 颜安青
 * @version 1.0
 */

public class Hello {
    public static void main(String[] args) {
        System.out.println("Hello类");
    }
}

②打开Hello.java文档的位置，从这个地方用cmd进入控制台
图1：

图2：

成功进入：

③输入javadoc命令
标准形式：javadoc -d 文件夹名 -xx -yy 源文件.java（具体参考下图）

我存储.html的地址为e:\fileComment\Hello，上面的代码中我只用到author和version两个，如果还使用了其他需要加上去，记得要加上前面的‘-’和空格。

如果出现图片上的错误，是因为cmd进入的入口错误，要真正找到Hello.java存放的文件地址才可以，eg：从E:\code\JavaLearn 变成从 E:\code\JavaLearn\src进去

④打开相应的网页文件

结果显示：

文档注释在实际开发中使用频率挺高的，所以最好能了解多一点。
 

出现问题可能用到的文档：
1、Java 文档注释（菜鸟教程）
2、javadoc‘ 不是内部或外部命令，也不是可运行的程序 或批处理文件
 

本人正在B站跟着韩顺平老师学Java（非广告），所以做个笔记仅供学习，文章虽标为原创，但大体思路是韩顺平老师的授课思路，在此基础上加上了自己的理解，不喜勿喷哦。