代码审查表.doc

信息技术中心网站技术部代码审查表版本更新时间修改人备注V1.02013？文档创建审查项目检查分项风格检查命名、格式是否符合对应的规范文档文件命名清晰，无歧义代码缩进、对齐格式正确，可使用IDE工具进行整理代码行控制在100字符，文件行数小于2000行，方法行数小于100行方法、属性、变量和功能代码块之间使用空行进行分隔是否存在重复的代码是否使用了GOTO语句注释检查使用统一的注释风格，注释必须使用易于识别的文本和符号每个类，每个方法都应有注释，注释量不低于代码行数的20%注释应随着代码改变而更新，保证无用的代码和注解已删除重要变量、复杂算法、循环和逻辑分支处必须有注释注释应解释为什么，而不是描述做什么，做什么是由代码自解释的注释应说明意外、异常情况，注明原因和解决办法类定义检查命名规则是否符合命名规范类的职责是否过少或过多，类的属性或者方法是否没有被使用是否存在如下的调用形式：a.b().c()是否存在两个类完成类似的工作，使用了不同的方法名，却没有同一个父类是否存在某个子类仅使用了父类的部分属性或方法当功能变化或逻辑修改时，是否要修改多个类是否正确使用类修饰符派生类的构造方法应调用基类的构造方法方法检查方法名应能明确定义了操作目标以及实现的功能方法的参数遵循一个明显有序的顺序方法应当只做一件事情，并做好参数应小于7个，过多的参数应使用参数类或实体封装方法检查了输入数据的合法性，return语句是否合理方法对可能引发的异常处理有清楚的标识重载、覆盖与隐藏是否被正确使用运算符、操作符的重载是否符合规范对于重复出现并完成同样单一功能的代码，是否进行了封装循环/分支检查最普遍的状况应在在if下处理，而不是else中分值嵌套层次小于3层当有明确的多次循环操作，使用for当有不明确的多次循环操作，使用while循环嵌套的层次小于3层，是否存在死循环多个if使用switch语句表达是否更清晰循环体内不要随意修改循环变量和步长值break和continue语句使用是否正确循环和分值的边界值是否合适定义检查定义常量所有字母应大写，单词之间用下划线连接代码中的常量应用是否合适，非必要不要使用全局变量不同的类的属性，如有相同的作用，则使用同样的名称同一个类，避免方法名、变量名、类名、属性名之间相同变量都在使用时赋值，名称应与其功能一致确保所有的变量都被使用，不能存在未使用的变量变量在使用前进行必要的检查和异常处理变量是否赋予了正确的长度，类型，精度是否合适默认的值或属性是否被正确理解和应用IO检查文件打开应用是否合适（如：ReadWrite打开后仅执行读取）文件使用前是否正确打开文件使用后是否确认关闭文件结束条件是否被正确处理，是否处理了可能的I/O错误文件字符集、编码格式、命名格式符合规范需要关闭的对象是否关闭，资源是否被释放（如：数据库连接）运算检查数组访问是否考虑越界情况数组是否过大或过小运算符的优先顺序应使用括号正确标识，能简单正确的快速理解是否存在浮点数是否相等比较是否存在不必要的跨数据类型的赋值或比较不同数据类型的转换是否正确是否存在除0错误是否存在超出分支路径的情况接口检查数据结构定义应为局部的，并且通过定义好的方法进行访问方法接口修改时不应影响其他代码模块代码体系构架对空间和速度都已经进行充分考虑是否引用了与当前入口点无关的参数是否改变了作为输入值的参数是否以参数形式传递了常量边界值的传递和调用是否正确对调用的返回值是否进行了检查其他检查查找数据库表时，只取出确实需要的那些字段对错误处理、调用资源是否已释放所有资源，是否有正确的提示对多线程访问的全局变量是否缺少信号量