代码审查报告(共4页).doc

精选优质文档-----倾情为你奉上
精选优质文档-----倾情为你奉上
专心---专注---专业
专心---专注---专业
精选优质文档-----倾情为你奉上
专心---专注---专业
代码审查报告
检 查 人：_____注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。
是[ ] 否[ ] 免[ ]
2-10：数据结构声明(包括数组、结构、类、枚举等)，如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释放在此域的右方。
是[ ] 否[ ] 免[ ]
2-11：全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
是[ ] 否[ ] 免[ ]
2-12：注释与所描述内容进行同样的缩排。
是[ ] 否[ ] 免[ ]
2-13：将注释与其上面的代码用空行隔开。
是[ ] 否[ ] 免[ ]
2-14：对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。
是[ ] 否[ ] 免[ ]
2-15：对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。
是[ ] 否[ ] 免[ ]
3 标识符命名
3-1：标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。
是[ ] 否[ ] 免[ ]
3-2：命名中若使用特殊约定或缩写，则要有注释说明。
是[ ] 否[ ] 免[ ]
3-3：自己特有的命名风格，要自始至终保持一致，不可来回变化。
是[ ] 否[ ] 免[ ]
3-4：对于变量命名，禁止取单个字符（如i、j、k...），建议除了要有具体含义外，还能表明其变量类型、数据类型等，但i、j、k作局部循环变量是允许的。
是[ ] 否[ ] 免[ ]
3-5：命名规范必须与所使用的系统风格保持一致，并在同一项目中统一，比如采用UNIX的全小写加下划线的风格或大小写混排的方式，不要使用大小写与下划线混排的方式。
是[ ] 否[ ] 免[ ]
4 可读性
4-1：注意运算符的优先级，并用括号明确表达式的操作顺序，避免使用默认优先级。
是[ ] 否[ ] 免[ ]
4-2：避免使用不易理解的数字，用有意义的标识来替代。涉及物理状态或者含有物理意义的常量，不应直接使用数字，必须用有意义的枚举或宏来代替。
是[ ] 否[ ] 免[ ]
5-1：去掉没必要的公共变量。
是[ ] 否[ ] 免[ ]
5-2：仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。
5-3：明确公共变量与操作此公共变量的函数或过程的关系，如访问、修改及创建等。
5-4：当向公共变量传递数据时，要十分小心，防止赋与不合理的值或越界等现象发生。
5-5：防止局部变量与公共变量同名。