Java 注释

Java 注释

在计算机编程中，注释（Comment）是程序员在代码中添加的说明性文本，不会被编译器或解释器执行。

注释是良好的编程习惯，它能帮助开发者更轻松地理解代码的功能和设计意图。

✅ 在 Java 编程中，注释主要分为以下三种类型：

---

单行注释

单行注释以双斜杠//开头，后面跟随注释内容：

// 这是一个单行注释
int x = 10; // 初始化一个变量 x 为10

---

多行注释

多行注释以/*开头，以*/结尾，适用于需要跨越多行的代码说明：

/*
这是一个多行注释
可以用来注释多行代码
*/
int y = 20; // 初始化一个变量y为20

---

文档注释

文档注释以/**开头，以*/结尾，通常出现在类、方法、字段等的声明前面，用于生成代码文档。

这种注释可以被工具提取并生成 API 文档，如 JavaDoc。

/**
 * 这是一个文档注释示例
 * 它通常包含有关类、方法或字段的详细信息
 */
public class MyClass {
    // 类的成员和方法
}

✅ 文档注释通常遵循特定的格式规范，包含一系列标准标签。例如：

• @param 用于说明方法参数
• @return 用于描述返回值
• @throws 用于注明可能抛出的异常

这些标准化标签不仅能确保注释的规范性，更能帮助生成结构清晰的 API 文档。通过规范的文档注释，其他开发者可以快速理解代码的功能和使用方式，从而提高代码的可维护性和协作效率。

---

---