Java代码注释规约

1、类、类属性、类方法的注释必须使用Javadoc规范，使用/**内容*/格式，不得使用 //内容 的方式。

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

/**
*  类名称，作用，作者，时间
*/
public class Test{
    /**
    * 这个字段是id
    */
    private Long id;

    /**
    * 保存方法
    */
    public void save(){
    }

}

2、所有抽象方法（包括接口中的方法）必须使用Javadoc注释，除了返回值、参数、异常说明外，还必须指出该方法做什么，实现什么。对子类的实现或调用注意事项也需要说明。

3、所有类都必须添加创建者信息。

4、方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/**内容*/，注意代码对齐。

5、所有枚举类型字段或是静态属性必须有注释，说明每个数据项的用途。

6、代码修改的同时，注释也要修改，尤其是参数、返回值、异常核心逻辑等。

7、注释掉的代码尽量配合说明，而不是简单的注释掉。如果是以后不用的代码建议直接删除。