注释是Java代码中非常重要的一部分，它就像给代码写“说明书”，能让代码更清晰易懂，方便自己和他人理解代码逻辑，也能在调试时快速定位问题。编译器会自动忽略注释内容，所以注释不会影响代码的执行。下面我们来详细了解Java中的三种注释类型：单行注释、多行注释和文档注释。
一、单行注释（//）¶
格式：使用 // 开头，后面紧跟注释内容，只能注释单行。
示例：
// 这是单行注释，我可以写在代码行的后面
int score = 95; // 定义学生的分数为95分
// 也可以单独写一行，解释某段代码的作用
// 比如下面这行是计算两个数的和
int sum = 10 + 20;
注意：
- 单行注释只能注释单行内容，不能跨多行。如果要注释多行，需要每行都用 //。
- 单行注释不能嵌套使用，比如 // 这是// 嵌套的注释 会被编译器认为是语法错误。
二、多行注释（/ /）¶
格式：使用 /* 开头，*/ 结尾，中间可以包含多行内容。
示例：
/*
这是多行注释，可以跨越多行
我可以在这里写对一段代码的详细说明
比如下面这个方法的作用是打印用户信息
*/
public void printUserInfo(String name, int age) {
System.out.println("姓名：" + name + "，年龄：" + age);
}
/*
注意：多行注释不能嵌套！
比如下面这种写法会报错：
/* 这是嵌套注释 */
// 正确的写法是：
// 把嵌套的部分当成普通代码处理，或者拆分成多个单行注释
注意：
- 多行注释可以跨多行，但不能嵌套（即不能在 /* */ 内部再写 /* */）。
- 多行注释通常用于解释一段代码的整体逻辑，比如类的作用、复杂算法的步骤等。
三、文档注释（/* /）¶
格式：使用 /** 开头，*/ 结尾，专门用于生成API文档（比如用Javadoc工具生成帮助文档）。
特点：可以包含标签（如 @author、@param、@return 等），但对初学者来说，先掌握基本格式即可。
示例：
/**
* 这是文档注释，用于生成帮助文档
* @author 小明（作者信息）
* @version 1.0（版本号）
*
* 这个类用于管理用户信息
*/
public class User {
private String name;
private int age;
/**
* 构造方法，初始化用户信息
* @param name 用户姓名
* @param age 用户年龄
*/
public User(String name, int age) {
this.name = name;
this.age = age;
}
}
作用：通过Javadoc工具（Java自带的文档生成工具），可以将文档注释自动生成HTML格式的API文档，方便他人查看类、方法、字段的说明。
注释的规范与建议¶
- 不要写冗余注释：比如
// 定义变量这种无意义的注释，直接写代码更清晰。 - 突出重点：注释要解释“为什么这么写”“这段代码的作用”，而不是“这行代码做了什么”。
- 及时更新注释：如果代码逻辑修改了，注释也要同步更新，避免误导他人。
- 合理使用位置：
- 类/接口：用文档注释（/** */）说明功能。
- 方法：用文档注释说明参数、返回值、异常等。
- 复杂逻辑：用多行注释（/* */）拆解步骤。
- 变量/代码行：用单行注释（//）补充说明。
总结¶
- 单行注释：快速注释单行内容，适合简短说明。
- 多行注释：解释一段代码的整体逻辑，适合复杂逻辑。
- 文档注释：生成API文档，适合类、方法的规范说明。
合理使用注释能让你的代码“会说话”，既方便自己后续维护，也能让团队协作更顺畅。记住：好的注释是代码质量的加分项，而不是负担哦！