Java 文档注释：注意与建议：✅四条实践建议

✅四条实践建议

• ① 公共 API 一定要写，内部实现可省略
• ② 描述写「做什么」而不是「怎么做」
• ③ 参数、返回值、异常一个都别漏
• ④ 在 IDE 里配置注释模板，省时又规范

🧩IDE 模板示例

• 在 Eclipse / IDEA 里设好模板，
• 敲快捷键就自动补全注释骨架：
• @Title、@Description、@Param、
• @Return、@author、@CreateDate。

🎯 速记口诀

• 文档注释 /** ... */，javadoc 一键出 HTML；
• 类上写 @author / @version，
• 方法上写 @param / @return / @throws；
• 要跳转用 @see 或 {@link}，
• void 方法别写 @return。