Java 注释总览
注释是源码中解释代码作用的文本，增强可读性与可维护性，不会被编译器包含在最终程序中。本手册把 Java 注释压缩成 8 张速查图。
本手册包含
- 注释是什么：定义、作用、为什么不会影响运行
- 单行注释 //：语法、适用场景、IDE 快捷键
- 多行注释 /* */：语法、嵌套禁忌、临时屏蔽代码
- 文档注释 /** */：javadoc 提取规则、书写格式
- javadoc 标签速查 ：17 个标签分上下两页（@author @param @return @throws @see @since @deprecated {@link} {@docRoot} 等）
- javadoc 输出与避坑：命令用法、输出内容、2 个常见报错
适合谁看
- 刚学 Java 不知道注释怎么写的初学者
- 想规范团队代码注释风格的开发者
- 需要生成 API 文档但忘了 javadoc 标签的程序员