1.【强制】类、类属性、类方法的注释必须使用 Javadoc规范，使用/**内容*/格式，不得使用
//xxx方式。
说明：在 IDE编辑窗口中，Javadoc方式会提示相关注释，生成 Javadoc能够正确输出相应注
释；在 IDE中，工程调用方法时，不进入方法便可悬浮提示方法、参数、返回值的意义，提升
阅读效率。程序员
2.【强制】全部的抽象方法（包括接口中的方法）必需要用 Javadoc注释、除了返回值、参数、
异常说明外，还必须指出该方法作什么事情，实现什么功能。
说明：对子类的实现要求，或者调用注意事项，请一并说明。spa
3.【强制】全部的类都必须添加建立者和建立日期。设计
4.【强制】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释
使用/* */注释，注意与代码对齐。接口
5.【强制】全部的枚举类型字段必需要有注释，说明每一个数据项的用途。同步
6.【推荐】与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持
英文原文便可。
反例：“TCP链接超时”解释成“传输控制协议链接超时”，理解反而费脑筋。io
7.【推荐】代码修改的同时，注释也要进行相应的修改，尤为是参数、返回值、异常、核心逻辑
等的修改。
说明：代码与注释更新不一样步，就像路网与导航软件更新不一样步同样，若是导航软件严重滞后，
就失去了导航的意义。效率
8.【参考】注释掉的代码尽可能要配合说明，而不是简单的注释掉。
说明：代码被注释掉有两种可能性：1）后续会恢复此段代码逻辑。2）永久不用。前者若是没
有备注信息，难以知晓注释动机。后者建议直接删掉（代码仓库保存了历史代码）。变量
9.【参考】对于注释的要求：第1、可以准确反应设计思想和代码逻辑；第2、可以描述业务含
义，使别的程序员可以迅速了解到代码背后的信息。彻底没有注释的大段代码对于阅读者形同
天书，注释是给本身看的，即便隔很长时间，也能清晰理解当时的思路；注释也是给继任者看
的，使其可以快速接替本身的工做。软件
10.【参考】好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的
一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是至关大的负担。
反例：
// put elephant into fridge
put(elephant, fridge);
方法名 put，加上两个有意义的变量名 elephant和 fridge，已经说明了这是在干什么，语
义清晰的代码不须要额外的注释。程序
11.【参考】特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，经过标记扫描，
常常清理此类标记。线上故障有时候就是来源于这些标记处的代码。
1） 待办事宜（TODO）:（ 标记人，标记时间，[预计处理时间]）
表示须要实现，但目前还未实现的功能。这其实是一个 Javadoc的标签，目前的 Javadoc
尚未实现，但已经被普遍使用。只能应用于类，接口和方法（由于它是一个 Javadoc标签）。
2） 错误，不能工做（FIXME）:（标记人，标记时间，[预计处理时间]）
在注释中用 FIXME标记某代码是错误的，并且不能工做，须要及时纠正的状况。