软件代码审查报告
检查人：检查日期：审查内容：审查总结果：说明：年月日
审查类型
序号条款
123456
一般情况下，源程序有效注释量必须在20％以上。
程序文件头部应进行注释（我们公司目前，主要指java、js、m与cs文件），务必按照公司统一格式，列出：版权说明、版本号、生成日期、作者、模块目的功能、主要函数及其功能、修改日志等。函数头部应进行注释，列出：函数的目的功能、输入参数、输出参数、返回值、调用关系（函数、表）等。边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。注释的内容要清楚、明了，含义准确，防止注释二义性避免在注释中使用缩写，特别是非常用缩写。注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。数据结构声明包括数组、结构、类、枚举等，如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释放在此域的右方。全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
一：注释
78910
11注释与所描述内容进行同样的缩排12将注释与其上面的代码用空行隔开。13对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。
对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处
14理，必须在该case语句处理完、下一个case语句前加上明确的注释。12
标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。命名中若使用特殊约定或缩写，则要有注释说明。自己特有的命名风格，要自始至终保持一致，不可来回变化对于变量命名，禁止取单个字符（如i、j、k），建议除了要有具体含义外，还能表明其变量类型、数据类型等，但i、j、k作局部循环变量是允许的。命名规范必须与所使用的系统风格保持一致，并在同一项目中统一，比如采用UNIX的全小写加下划线的风格或大小写混排的方式，不要使用大小写与下划线混排的方式。
二：标识符命名
34512
三：可读性
注意运算符的优先级，并用括号明确表达r