注释规约

1. 【强制】类、类属性、类方法的注释必须使用 Javadoc 规范，使用 /* 内容 / 格式，不得使用 // xxx 方式。
   说明:在 IDE 编辑窗口中，Javadoc 方式会提示相关注释，生成 Javadoc 可以正确输出相应注释;在 IDE 中，工程调用 方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。
2. 【强制】所有的抽象方法(包括接口中的方法)必须要用 Javadoc 注释、除了返回值、参数异常说明 外，还必须指出该方法做什么事情，实现什么功能。
   说明:对子类的实现要求，或者调用注意事项，请一并说明。
3. 【强制】所有的类都必须添加创建者和创建日期。 说明:在设置模板时，注意 IDEA 的@author 为${USER}，而 eclipse 的@author 为${user}，大小写有区别，而日期 的设置统一为 yyyy/MM/dd 的格式。 正例:

/** *
* @author yangguanbao
* @date 2021/11/26 *
**/

4. 【强制】方法内部单行注释，在被注释语句上方另起一行，使用 // 注释。方法内部多行注释使用 /* */ 注释，注意与代码对齐。
5. 【强制】所有的枚举类型字段必须要有注释，说明每个数据项的用途。
6. 【推荐】与其用半吊子英文来注释，不如用中文注释说清楚。专有名词与关键字保持英文原文即可。 反例:“TCP 连接超时”解释成“传输控制协议连接超时”，理解反而费脑筋。
7. 【推荐】代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等。 说明:代码与注释更新不同步，就像公路网与导航软件更新不同步一样，如果导航软件严重滞后，就失去了导航的意义。
8. 【推荐】在类中删除未使用的任何字段和方法、内部类;在方法中删除未使用的参数声明与内部变量。
9. 【参考】谨慎注释掉代码。在上方详细说明，而不是简单地注释掉。如果无用，则删除。
   说明:代码被注释掉有两种可能性:
   1)后续会恢复此段代码逻辑。
   2)永久不用。前者如果没有备注信息，难以知晓注 释动机。后者建议直接删掉即可，假如需要查阅历史代码，登录代码仓库即可。