Java 注释

提示

1. 注释的作用：Java 注释被编译器忽略，用于帮助开发者理解代码，如解释变量声明和输出语句。
2. 注释类型：Java 提供单行注释 (//) 和多行注释 (/* ... */)，分别用于简短和跨多行的说明。
3. 注释的正确使用：注释不应替代清晰代码，而是解释复杂部分或选择特定技术的理由，重点在于说明“为什么”而非“如何”。

在计算机编程中，注释是程序的一部分，但 Java 编译器完全忽略它们。它们主要用于帮助程序员理解代码。例如，

// 声明并初始化两个变量
int a = 1;
int b = 3;

// 打印输出
System.out.println("这是输出");

这里，我们使用了以下注释：

• 声明并初始化两个变量
• 打印输出

Java 中的注释类型

Java 中有两种类型的注释：

• 单行注释
• 多行注释

单行注释

单行注释从同一行开始并结束。要编写单行注释，我们可以使用 // 符号。例如，

// "Hello, World!" 程序示例

class Main {
    public static void main(String[] args) {
        // 打印 "Hello, World!"
        System.out.println("Hello, World!");
    }
}

输出：

Hello, World!

这里，我们使用了两个单行注释：

• "Hello, World!" 程序示例
• 打印 "Hello World!"

Java 编译器忽略从 // 到行尾的所有内容。因此，它也被称为 行尾 注释。

多行注释

当我们想在多行中编写注释时，可以使用多行注释。要编写多行注释，我们可以使用 /..../ 符号。例如，

/* 这是一个多行注释的示例。
 * 该程序将 "Hello, World!" 打印到标准输出。
 */

class HelloWorld {
    public static void main(String[] args) {

        System.out.println("Hello, World!");
    }
}

输出：

Hello, World!

这里，我们使用了多行注释：

/* 这是一个多行注释的示例。
* 该程序将 "Hello, World!" 打印到标准输出。
*/

这种类型的注释也被称为 传统注释。在这种类型的注释中，Java 编译器忽略从 /* 到 */ 的所有内容。

正确使用注释

您应该始终考虑的一点是，注释不应该用来替代用英语解释写得不好的代码。您应该始终编写结构良好且自解释的代码。然后，使用注释。

有些人认为代码应该是自描述的，注释应该很少使用。然而，在我个人看来，使用注释没有问题。我们可以使用注释来解释复杂的算法、正则表达式或在解决问题时必须在不同技术中选择一种技术的场景。

注意：在大多数情况下，始终使用注释来解释“为什么”而不是“如何”，这样就可以了。