教妹学Java(二十)：一文带你彻底了解 Java 中的注释，干货了

“二哥，今天我们要学习的内容是‘Java 注释’，对吧？”

“是的，三妹。Java 注释通常用来说明一个变量的用处、一个方法的 API、一个类的作用等等，它不会被编译器和解释器执行，但程序员可以通过注释来更好地理解代码。”

注释有 3 中类型：

1）单行注释

int age = 18; // age 用于表示年龄

单行注释通常用于解释单行代码的作用

2）多行注释

/*

age 用于表示年纪

name 用于表示姓名

*/

int age = 18;

String name = "沉默王二";

多行注释使用的频率其实并不高，通常用于解释一段代码的作用。

3）文档注释

/**
 * 这个类用于演示文档注释
 * 
 * @author 沉默王二
 */
public class CommentDemo {
    /**
     * main 函数为程序的主入口
     * @param args 
     */
    public static void main(String[] args) {
    }
}

文档注释可用于类级别，解释这个类的基本作用，以及注意事项；也可以用于方法级别，解释方法的参数，返回类型，以及方法的作用。

当这个类保存后，我们可以执行 javadoc 命令生成 API 文档。

javadoc CommentDemo.java -encoding utf-8

-encoding utf-8 可以保证中文不发生乱码。稍等片刻，javadoc 命令正在执行。

等待文档生成。然后在对应文件夹下可以看到生成的文件。

双击点开 index.html 文件就可以通过浏览器查看我们写的注释文档了。

可以看到我们之前写的文档注释了。有没有很开心？