Java 文档注释：注意与建议：🏷️标签速查
常见坑。
🏷️标签速查
- @author 作者 @version 版本
- @param 参数说明 @return 返回值
- @throws / @exception 抛出的异常
- @see 参见 {@link} 内联链接
- @since 起始版本 @deprecated 已废弃
- {@code} 代码块 {@value} 常量值
- {@docRoot} 文档根路径 {@inheritDoc} 继承注释
📝写注释的三条原则
- ① 解释「为什么」，而不是复述代码
- ② 保持同步：改了代码就要改注释
- ③ 别写废话：i++ 不用注释「自增」
- 好的注释补充代码没说的信息，
- 坏的注释只是重复代码。