阿里巴巴Java开发手册学习小结7-注释规约

本次学习 来源 阿里巴巴Java开发手册 ，文档更新时间2016.12.7 是阿里巴巴集团技术部 首次向Java业界公开，如果有需要开发手册源文档的，欢迎联系
要养成良好的代码注释习惯~

编程规范

注释规约

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

2.【强制】所有的抽象方法（包括接口中的方法）必须要用javadoc 注释，除了返回值，参数，异常说明外，还必须指出该方法做什么事情，实现什么功能。
说明：如有实现和调用注意事项，请一并说明。

3.【强制】所有的类都必须添加创建者信息

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

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

6.【推荐】与其半吊子英文注释，不如用中文注释把问题说清楚，专有名词，关键字，保持英文原文即可。

7.【推荐】代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。

8.【参考】注释掉的代码尽量要配合说明，而不是简单的注释掉。
说明：代码被注释掉有两种可能性：1，后续会恢复此段代码逻辑，2，永久不用。前者如果没有备注信息，难以知晓注释动机，后者建议直接删掉（代码仓库保存了历史代码）

9.【参考】对于注释的要求：

• 第一 能够准确反应设计思想和代码逻辑；
• 第二 能够描述业务含义，使别的程序员能够迅速了解到代码背后的信息。

说明：完全没有注释的打断代码对于阅读者形同天书，注释是给自己看的，即使隔了很长时间，也能清晰理解当时的思路；注释也是给继任者看的，使其能够快速接替自己的工作。

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

11.【参考】特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。

• 1 待办事宜（TODO）:（ 标记人，标记时间，[预计处理时间]）
  表示需要实现，但目前还未实现的功能。这实际上是一个javadoc的标签，目前的javadoc还没有实现，但已经被广泛使用。只能应用于类，接口和方法（因为它是一个javadoc标签）。

• 2 错误，不能工作（FIXME）:（标记人，标记时间，[预计处理时间]）
  在注释中用FIXME标记某代码是错误的，而且不能工作，需要及时纠正的情况