《编写系统软件：代码注释》[http://antirez.com/news/124](https://t.co/Oks5TtyfcI) 在"代码注释"这个主题上，来自 Redis 作者 antirez 的这篇文章我的最爱之一。通过整理 redis 项目里的所有注释，antirez 将注释一共划分成 9 类，各自承担不同功用。本文的独特之处，在于立足"用注释解释代码中的 'why？'"这条共识上，重点介绍了"教学性/指引性注释"这类不太常规的注释。文章提到，"指引性注释"是 redis 中数量最多的注释，充斥整个项目，antirez 认为它们对项目帮助巨大。某种程度上，这篇文章影响了我的编码习惯。再次回顾它，我想起那句人们重复提及的老话："代码主要是写 <!-- more --> 1.【强制】类、类属性、类方法的注释必须使用 Javadoc 规范，使用星号格式，不得使用 // xxx 方式。 3.【强制】所有的类都必须添加创建者和创建日期。 2.【强制】所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释、除了返回值、参数异常说明外，还必须指出该方法做什么事情，实现什么功能。说明：对子类的实现要求，或者调用注意事项，请一并说明。 4.【强制】方法内部单行注释，在被注释语句上方另起一行，使用 // 注释。方法内部多行注释使用星号注释，注意与代码对齐。 5.【强制】所有的枚举类型字段必须要有注释，说明每个数据项的用途。