四、Java 中的注释

在这节开始前，我们先想一个问题：我们称 Java 为一种计算机编程语言，人类的语言是人与人交流的工具，那么计算机语言是哪两方的交流工具呢？

计算机编程语言是程序员与编译器交流的工具，而编译器负责把编程语言翻译为计算机看得懂的语言，从而是程序可以在计算机上运行。

编译器作为一种程序，只要代码符合语法规则，哪怕代码中使用的标识符是脸滚键盘打出来的无意义词语，它也能读懂。但程序员作为人，如果读到的尽是些意义不明的词汇，便很难理解一段文字，这就是我们使用标识符时，要 “见名知意” 的原因。

但不管标识符怎样 “见名知意” ，编程语言作为编译器的语言，可读性总是不如人类的自然语言的。为了能够在代码中，写下自然语言，便于代码引导者理解代码，“注释” 诞生了。

注释中写的是人类的自然语言，编译器是看不懂的，所以编译器会忽略它们。

Java 中，存在三种注释。

1 单行注释

以双斜杠“//”标识，只能注释一行内容，但也可以将多个单行注释堆叠在一起使用，这样就可以注释多行内容。

单行注释常用于注释较短的内容。

在实际编程中，我们也常使用单行注释，使某一行或多行代码暂时失效，这在不希望删除某段代码，又不希望它起作用时，很有必要。

在 IDEA 中，使用 Ctrl + / 键，可以快速在一行的前面加上 // 。

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

2 多行注释

包含在“/*”和“*/”之间，能注释很多行的内容。为了可读性比较好，一般首行和尾行不写注释信息。

在 IDEA 中，使用 Ctrl + Shift + / 键，可以快速创建 /**/ 。

public class Hello {
    public static void main(String[] args) {
        /*
        * 这是多行注释。
        * 可以注释多行内容
        */
        System.out.println("Hello");
    }
}

3 文档注释

包含在“/**”和“*/”之间，也能注释多行内容，一般用在类、方法和变量上面，用来描述其作用。

注释后，鼠标放在类、方法或者变量上面会自动显示出我们注释的内容，这能让极大地便利我们的开发。

我们也可以通过工具，将文档注释变为真正的文档，效果就像 Java 的官方文档：https://docs.oracle.com/en/java/javase/20/docs/api/index.html 。

但文档注释要在类和方法上使用，使用我们将在之后讲解它的具体用法。