Java 文档注释：注意与建议：🚧常见坑与注意

🚧常见坑与注意

• ① 文档注释必须放在类/方法/字段正上方
• ② 中文乱码要加 -encoding UTF-8
• ③ 只有 public / protected 会被默认输出
• ④ 私有成员需加 -private 参数
• ⑤ HTML 标签可直接使用，< 要转义

🆚三种注释怎么选

• // 单行注释
• 临时说明、行尾补充，不进文档。
• /* */ 多行注释
• 大段说明、临时屏蔽代码，不进文档。
• /** */ 文档注释
• 类、方法、字段说明，能被 javadoc 提取。