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