Java 注释

在本教程中，您将了解 Java 注释、为什么使用注释以及如何以正确的方式使用注释。

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

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

// 打印输出
System.out.println("This is output");

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

• 声明和初始化 2 个变量
• 打印输出

Java 中的注释类型

在 Java 中，有两种类型的注释：

• 单行注释
• 多行注释

单行注释

顾名思义，单行注释就是只存在一行中注释。我们使用 // 符号开始单行注释。例如，

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

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

输出：

Hello, World!

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

• “Hello, World!” 示例程序
• 打印输出 “Hello, World!”

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

多行注释

当我们想写多行注释时，使用 /*....*/。Java 编译器会忽略从 /* 到 */ 的所有内容。例如，

/* 这是多行的一个例子。
 * 这个程序向标准输出打印 "Hello, World!" 字符串。
 */

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

输出：

Hello, World!

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

/* This is an example of multi-line comment.
 * The program prints "Hello, World!" to the standard output.
 */

这种类型的注释也称为传统注释。

正确使用注释

您应该始终坚持的一件事情是，注释不是代替拙劣代码的方法。您应该始终首先编写结构良好且自我解释的代码，然后再使用注释。

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

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