Java 三种注释完整详解
一、单行注释 //
语法
// 单行文字说明inta=10;// 行尾注释作用
- 只作用于当前一行，// 后面内容全部被编译器忽略；
- 用于简单说明变量、单行代码逻辑；
- 可写在代码上方，也可写在代码右侧。
特点
不能换行，换行就要再加//。
二、多行注释 /* */
语法
/* 这里可以写 多行说明文字 */intnum=20;作用
- 包裹一段多行文本，中间所有内容都为注释；
- 适合大段代码说明、临时屏蔽一大段代码；
限制
不能嵌套使用
/* /* 内层注释，会直接报错 */*/三、文档注释 /** */（专用生成API文档）
语法
/** * 文档注释，写在类/方法/变量上方 * @param a 参数a说明 * @return 返回值描述 */publicstaticintadd(inta,intb){returna+b;}核心特点
- 只放在类、方法、成员变量上方；
- 支持专用标签
@param@return@throws@author@version； - 使用
javadoc命令可以自动生成 HTML 接口帮助文档，项目开发、开源框架必备。
常用标签
@author作者@version版本@param方法参数说明@return返回值说明@throws/@exception抛出异常
四、三者核心区别
//单行：少量简单备注、临时注释单行代码/* */多行：批量屏蔽代码、大段文字描述，无法生成文档/** */文档注释：给使用者看的标准接口说明，支持导出API文档
五、使用规范
- 简单解释变量用单行
//； - 临时注释掉几十行测试代码用
/* */； - 对外提供调用的类、工具方法，必须使用文档注释；
- 注释语言简洁，不要重复复述代码本身逻辑；
- 正式项目禁止大量无用注释。
六、完整示例
/** * 加法工具类 * @author admin * @version 1.0 */publicclassTest{// 定义常量数字publicstaticfinalintMAX=100;/** * 两数相加 * @param a 第一个整数 * @param b 第二个整数 * @return a加b的结果 */publicintsum(inta,intb){/* int temp = 0; temp = a + b; */returna+b;// 计算和}}
