Java注释规范

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

说明：

1)       在 IDE 编辑窗口中，Javadoc 方式会提示相关注释，生成 Javadoc 可以正确输出相应注释

2)       在 IDE 中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率

 

2.所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释，指明方法用途、入参、返回值和异常说明

 

3.单行注释使用 // ，多行注释使用 /* */

说明：单行注释建议在被注释语句上方另起一行

 

4.所有的枚举类型字段必须要有注释，说明每个数据项的用途

 

5.注释力求精简准确、表达到位。好的注释不应走极端：既不应该不加思考随处注释，也不应该大段代码特别是逻辑层次复杂的代码没有任何注释

说明：

1)       简单的代码逻辑以及无意义的变量声明完全没有必要注释，过分注释只会让代码看起来凌乱不堪

2)       完全没有注释的大段代码对于阅读者形同天书。好的注释应当在隔很久之后自己一眼就能看明白这段代码想表达什么。同时，让接手代码的人也能毫不费力地理解该段代码的意图

 

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