java注释是提升代码可读性、协作效率和长期维护的关键，分为单行注释（//）、多行注释（/.../）和文档注释（/*.../），分别用于行级说明、局部逻辑描述和api文档生成，需遵循同步更新、面向读者、拒绝翻译式注释三大原则。
Java注释不是可有可无的装饰，而是代码可读性、协作效率和长期维护的关键。写对注释，等于提前为未来的自己和团队节省大量时间。
单行注释：用//快速说明“这一行在做什么”
单行注释适合解释变量用途、某行逻辑意图或临时调试标记。它紧贴被说明的代码，不跨行，不嵌套。
- 写在代码上方或右侧（右侧时留至少两个空格），例如：
int count = 0; // 初始化计数器，用于统计有效请求 - 避免写废话，如
// i++或// 赋值——代码本身已清晰，注释应补充“为什么”而非“是什么” - 调试时可用
// TODO、// FIXME标记待办事项，多数IDE会高亮识别
多行注释：用/* ... */临时禁用代码块或说明局部逻辑
多行注释适用于暂时屏蔽几行代码，或对一小段连续逻辑做简要说明（比如复杂条件判断的意图）。
- 不用于替代文档注释，也不建议大段包裹业务说明——那样会让代码区和注释区边界模糊
- 注意不能嵌套，
/* 外层 /* 内层 */ */会导致编译错误；若需注释含*/的字符串，改用多个单行注释更安全 - 示例：在算法关键分支前加说明：
/* 若用户等级≥5，跳过缓存直接查DB，确保数据实时性 */
文档注释：用/** ... */生成API说明，必须规范书写
文档注释（Javadoc）是Java生态中自动生成API文档的基础，只用于类、接口、方法、字段等程序元素的声明上方。
- 以
/**开头，每行首可加*（IDE通常自动补全），结尾用*/ - 第一句为简明摘要（不超过100字符），后接空行，再写详细说明；使用标准标签如
@param、@return、@throws，且每个标签独占一行 - 方法文档必须说明参数含义、返回值语义、可能抛出的异常及触发条件，例如：
/*** 根据订单ID查询完整订单详情，包含商品、物流与支付信息。* @param orderId 订单唯一标识，不能为空或负数* @return 订单对象；若不存在则返回null* @throws IllegalArgumentException 当orderId格式非法时抛出*/
三个原则帮你避开常见坑
注释不是越多越好，而是越准越好。真正影响质量的是态度和习惯。
- 保持同步：代码修改后，对应注释必须立刻更新，过期注释比没有更危险
- 面向读者：写给下一个看代码的人（很可能是2周后的你自己），用对方能懂的语言，避免缩写或内部黑话
-
拒绝“翻译式”注释：不要把
for (int i = 0; i 写成“循环遍历列表”——这是代码本意；要写“按创建时间倒序校验前10条记录”
Java免费学习笔记：立即使用
解锁 Java 大师之旅：从入门到精通的终极指南
