Java 注释：类型、用法与最佳实践

Java 注释

本指南解释 Java 注释、其重要性及正确使用方法，助你编写更清晰、可维护的代码。

编程中，注释是 Java 编译器忽略的源代码片段。它们帮助开发者理解代码意图而不影响执行。例如：

// 声明并初始化两个变量
int a = 1;
int b = 3;
// 打印输出
System.out.println("This is output");

此处使用两条注释：声明并初始化两个变量 和 打印输出。

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!"。编译器忽略从 // 到行尾的所有内容。

多行注释

需多行时，使用 /* … */。示例：

/* 这是多行注释示例。
 * 程序向标准输出打印 "Hello, World!"。
 */
class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}

输出：


Hello, World!

编译器跳过 /* 与 */ 之间的所有内容。这也称为传统注释。

有效使用注释

注释不应替代清晰代码。先编写结构良好、自描述的代码，再添加注释解释决策背后的 “为什么” —— 复杂算法、设计选择或非显而易见的逻辑。

虽有人主张极简注释，但简洁解释能极大提升后期维护者的可读性。

注意：优先编写解释代码 为什么 存在的注释，而非如何工作。

理解 Java 表达式、语句与代码块精通 Java if…else：控制流全解析

java