阿里巴巴Java开发规约-注释规约篇

1.[强制] 类、类属性、类方法的注释必须使用Javadoc规范,使用/*内容/格式,不得使用// xxx方式。

说明: 在IDE编辑窗口中,Javadoc方式会提示相关注释,生成Javadoc可以正确输出相应注释;在IDE中,工程调用方法时,不进入方法即可悬浮提示方法、参数、返回值的意义,提高阅读效率。

2.[强制] 所有的抽象方法(包括接口中的方法)必须要用Javadoc注释、除了返回值、参数、异常说明外,还必须指出该方法做什么事情,实现什么功能。

说明: 对子类的实现要求,或者调用注意事项,请一并说明。

3.[强制] 所有的类都必须添加创建者和创建日期。

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

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

/**
 * @Description: 季节枚举类
 * @author: Gao Hang Hang
 * @date 2019/01/05 22:02
 */
public enum  SeasonEnum {
    
    /**
     * 春季
     */
    SPRING,

    /**
     * 夏季
     */
    SUMMER,

    /**
     * 秋季
     */
    FALL,

    /**
     * 冬季
     */
    WINTER;
}

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

反例: “TCP连接超时”解释成”传输控制协议连接超时”,理解反而费脑筋。

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

说明: 代码与注释更新不同步,就像路网与导航软件更新不同步一样,如果导航软件严重滞后,就失去了导航的意义。

8.[参考] 谨慎注释掉代码。在上方详细说明,而不是简单地注释掉。如果无用,则删除。

说明: 代码被注释掉有两种可能性:

• 后续会恢复此段代码逻辑。
• 永久不用。

前者如果没有备注信息,难以知晓注释动机。后者建议直接删掉(代码仓库保存了历史代码)。

9.[参考] 对于注释的要求: 第一、能够准确反应设计思想和代码逻辑;第二、能够描述业务含义,使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同天书,注释是给自己看的,即使隔很长时间,也能清晰理解当时的思路;注释也是给继任者看的,使其能够快速接替自己的工作。

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

反例:

// put elephant into fridge
put(elephant, fridge);

方法名put,加上两个有意义的变量名elephant和fridge,已经说明了这是在干什么,语义清晰的代码不需要额外的注释。

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

• 待办事宜(TODO): (标记人,标记时间,[预计处理时间]),表示需要实现,但目前还未实现的功能。这实际上是一个Javadoc的标签,目前的Javadoc还没有实现,但已经被广泛使用。只能应用于类,接口和方法(因为它是一个Javadoc标签)。
• 错误,不能工作(FIXME): (标记人,标记时间,[预计处理时间]),在注释中用FIXME标记某代码是错误的,而且不能工作,需要及时纠正的情况。

public class Test {
    // TODO: (高行行,2019-1-5,[2019-1-6])
    // FIXME: (高行行,2019-1-5,[2019-1-6])
}

打赏