3.21 java程序员如何写出漂亮的代码

代码文本注释规范

1)、一般情况下，源程序有效注释量必须在20%以上

注解：需要用SourceCounter工具查看代码的备注说明百分比

2)、源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块功能、主要函数及其功能、修改日志等

3)、函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等

4)、注释的内容要清楚、明了，含义准确，防止注释二义性

5)、避免在注释中使用缩写，特别是非常用缩写

6)、注释应与其描述的代码相近，对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开

7)、对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方

8)、数据结构声明(包括数组、结构、类、枚举等)，如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面;对结构中的每个域的注释放在此域的右方

9)、全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明

注解：对于注释，单行的注释要与其上面的内容用空行隔开

10)、避免在一行代码或表达式的中间插入注释

11)、在程序块的结束行右方加注释标记，以表明某程序块的结束

注解：以方便当代码段较长，特别是多重嵌套时的代码可读性