注释规范（java开发规范 阿里巴巴）

注释规范

1. 【强制】类、类属性、类方法的注释必须使用 Javadoc 规范，使用/*内容/格式，不得使用//xxx 方式。
   说明：

• 在 IDE 编辑窗口中，Javadoc 方式会显示相关注释，生成 Javadoc 可以正确输出相应注释；在 IDE 中，工程调用方法时，不进入方法即可悬浮ᨀ示方法、参数、返回值的意义，提高阅读效率。
• // 注释函数的话，不会显示在文档提示的功能里，但是/** */会提示。
• IDEA可以配置（悬浮显示方法注释），或者使用快捷键 Ctrl+Q 显示方法的注释

2. 【强制】所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。
   说明：对子类的实现要求，或者调用注意事项，请一并说明。
   抽象方法（抽象类和接口方法）要同时遵循2个规则：不要用修饰符（保持简洁） + 注释说明功能

3. 【强制】所有的类都必须添加创建者信息。（可以通过IDEA进行class模板设置，也留下了犯罪证据）

4. 【强制】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/* */注释，注意与代码对齐。

5. 【强制】所有的枚举类型字段必须要有注释，说明每个数据项的用途。

6. 【推荐】与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。
   反例：“TCP 连接超时”解释成“传输控制协议连接超时”，理解反而费脑筋。

7. 【推荐】代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。
   说明：代码与注释更新不同步，就像路网与导航软件更新不同步一样，如果导航软件严重滞后，就失去了导航的意义。

8. 【参考】好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的
   一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担。