Java注释分为单行(//)、多行(/.../)和文档(/*.../)三种:单行仅限本行,多行可跨行但不支持嵌套,文档注释用于生成API文档并支持@param等标签。

Java里的注释是写在代码中、不参与编译执行的说明性文字,用来解释逻辑、标记待办、临时禁用代码等,提升可读性和协作效率。
单行注释(//)
以两个斜杠 // 开头,作用范围仅限当前行。适合简短说明或临时屏蔽一行代码。
- 写在行首:// 计算用户登录失败次数
- 写在代码右侧:int retryCount = 0; // 初始重试次数为0
- 不能跨行,换行需重新加 //
多行注释(/* ... */)
用 /* 开始、*/ 结束,中间所有内容都被忽略,支持跨多行。适合稍长的说明或临时注释掉一段代码。
- 可换行书写:/* 这里是登录校验逻辑
包含密码强度检查和验证码验证 */ - 不能嵌套:/* 外层注释 /* 内层会报错 */ 这样写是非法的 */
- 常用于快速禁用几行代码,比逐行加 // 更方便
文档注释(/** ... */)
以 /** 开头、*/ 结尾,专为生成API文档设计(配合javadoc工具)。通常放在类、方法、字段前,支持特定标签如 @param、@return、@throws 等。
立即学习“Java免费学习笔记(深入)”;
- 示例:
/**
* 根据用户ID查询用户信息
* @param userId 用户唯一标识
* @return User对象,不存在返回null
*/
public User findUserById(String userId) { ... } - IDE(如IntelliJ、Eclipse)能自动识别并提示文档内容
- 不是所有注释都需写文档注释,只对需要公开或被他人调用的成员使用
注释不是越多越好,关键在准确、简洁、随代码更新。过时的注释比没有更误导人。










