Java注释规范

Java的注释规范

1、所有类、类方法、类属性的注释必须采用Javadoc规范，即采用/** 内容 */方式，包括抽象方法及接口中方法。

2、所有类必须添加创建者和创建日期；

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

4、所有的枚举类型字段必须要有注释，说明用途；

5、代码修改时，配套的注释也要同步修改；

6、注释无需过多，太多注释，代码修改时反而是累赘。