Java 注释（详细介绍）

一、简介

在计算机语言中，注释是计算机语言的一个重要组成部分，用于在源代码中解释代码的作用，可以增强程序的可读性，可维护性。Java 注释是一种在 Java 程序中用于提供代码功能说明的文本，注释不会被编译器包含在最终的可执行程序中，因此不会影响程序的运行。

Java 注释主要有三种类型：

• 单行注释
• 多行注释
• 文档注释

编写注释是一个良好的编程习惯，它们可以帮助程序员更容易地理解代码的用途和功能，并且在团队协作中非常有用。但需要注意的是代码的注释不是越多越详细越好，要尽量规范和优化自己的代码来减少不必要的注释，减轻阅读者的负担。

---

二、单行注释

使用 // 开头，其后的内容直到行尾都被视为注释，一般是用于解释某个单行代码的作用。

public class Main {
    public static void main(String[] args) {
        // 这是一个单行注释
    }
}

---

三、多行注释

以 /* 开头， */ 为尾，使用 Ctrl + Shift + / 可以快速生成多行注释，在多行注释内所有的内容都会被视为注释，一般用于解释一段代码的作用。

public class Main {
    public static void main(String[] args) {
        /*
        这是一个多行注释
        用于解释多行代码
         */
    }
}

---

四、文档注释

以 /** 开始，以 */ 结束，出现在类、方法、字段等的声明前面，用于生成代码文档，一帮用于生成 Java 开发文档。

public class Main {
    
    /**
     * @param a 参数一
     * @param b 参数二
     * @return 返回两个参数的和
     */
    public static int sum(int a, int b) {
        return a + b;
    }
}

文档注释的格式通常包含一些特定的标签，如 @param 用于描述方法参数，@return 用于描述返回值，@throws 用于描述可能抛出的异常等等，这些标签有助于生成清晰的API文档，以便其他开发者能够更好地理解和使用你的代码。

更多文档注释的内容可以参考：Java 文档注释 。

---