代码评审表——Java

1、JAVAJAVA代代码码评评审审表表约约定定：总总分分100=100=基基础础项项5050分分+ +重重点点项项5050分分。附附加加分分上上限限1010分分。针针对对每每一一大大项项评评分分，细细项项作作为为评评分分的的参参考考依依据据。大大项项评评分分小小于于该该项项总总分分的的60%60%或或大大于于该该项项总总分分的的80%80%必必须须给给出出说说明明。如如该该大大项项整整体体不不适适用用，评评分分栏栏填填写写“/”“/”。细细项项中中，带带删删除除线线的的项项可可忽忽略略，加加粗粗项项为为重重点点。部门名称项目名称模块列表类列表编号问 题类别一一、变变量量, ,属属性性和和常常量量

2、声声明明缺缺陷陷基基础础1变量和常量的命名是否与约定保持一致?2是否存在容易混淆的相似的变量和属性名?3变量和属性是否书写正确?4变量和属性是否被正确的初始化?5非局部变量是否能用局部变量替换?6所有的for循环的控制变量是否都在循环顶部被声明?7是否有应该命名为常量的文字常量?8变量和属性是否可以用常量替换?9属性是否可以用本地变量?10所有的属性是否都有正确的访问限制符(private,protected,public)?11是否有静态属性应该是非静态(反之亦然)?二二、方方法法定定义义缺缺陷陷基基础础1方法名的描述方法是否与命名约定一致?2每个方法的参数值在使用之前是否都作了检查?3对于

3、每一个方法,它是否都返回了正确的值?4每种方法是否都有正确的访问限制符(private, protected, public)?5静态方法是否应该为非静态(反之亦然)?6接口方法的声明是否正确的表达语义？是否正确的给出返回值或抛出异常？三三、类类定定义义缺缺陷陷基基础础1每一个类是否都有正确的构造函数?2在子类中是否有应该放到父类中的通用成员?3类的继承层次是否能被简化?四四、数数据据引引用用缺缺陷陷基基础础1对于每一个数组引用,下标值是否在定义的范围内?2对对于于对对象象和和数数组组引引用用, ,是是否否组组确确定定其其值值应应为为非非空空? ?3是是否否存存在在大大内内存存对对象象的的频频

4、繁繁创创建建或或引引用用？五五、计计算算/ /数数值值缺缺陷陷基基础础1是否存在不同类型数据之间的混合计算?2在计算中是否存在上溢或下溢的可能?3关于数值计算的顺序和优先级的假设是否正确?4代代码码是是否否避避免免了了对对浮浮点点型型数数值值的的相相等等比比较较操操作作? ?5被除数是否做了零值测试和噪音测试?6是否用了括号来避免模糊不清?7数值类型声明以及精度控制是否合理？8数值计算是否存在溢出的可能性？六六、流流程程控控制制缺缺陷陷基基础础1对于每一个循环:是否选用了最佳的循环结构?2所所有有的的循循环环是是否否都都能能结结束束? ?3如果一个循环有多个出口,是否每个出口都有必要并且得到正

5、确处理?4switch声明是否都有default条件?5是否所有的case-switch-break对应关系都已更正并加上批注？6是否named break叙述都跳到正确的地方？7循环和分支的嵌套是否过深?是否正确?8是否有if嵌套可以转换程switch嵌套?9空控制条件是否都正确，并加上括号及批注？10所有的异常是否都得到了正确的处理？11每一个方法是否都能结束?七七、输输入入输输出出缺缺陷陷基基础础1文件在被使用之前是否都被打开?2输入对象的属性是否与使用的文件一致?3在操作文件时是否判断了文件存在与否?4文文件件在在被被使使用用之之后后是是否否都都被被关关闭闭? ?5网络连接是否合理池化

6、(反之亦然)？6网络程序是否有合理的异常处理以及方法的异常声明？7网网络络连连接接是是否否正正常常关关闭闭？八八、注注释释缺缺陷陷基基础础1每一个方法,类和文件是否都有适当的头注释?2变量和常量的声明是否都有注释?3每个类和方法的潜在行为是否都有用简易的语言进行解释?4方法和类的头注释是否和它们的功能保持一致?5注释和代码是否保持一致?6注释对于理解代码是否有帮助?7代码中的注释是否充分?8代码中的注释是否过多?九九、程程序序结结构构重重点点1代码是否正确完整的实现了设计?2代码是否符合相关的编码标准?3代码结构是否适当,风格和格式是否保持一致?4代码中有没有被调用的或无用的程序,或没有被执行

7、的代码，或者测试代码？5代码中是否还有多余的脏程序或测试代码?6是否存在能被调用外部复用组件或库函数替代的代码?7有没有能被压缩成简单程序的程序块或重复的代码?8内内存存及及其其它它资资源源是是否否被被有有效效利利用用? ?9数字和字符串常量是否用符号代替?10是否有过于复杂的模块需要重新构造或拆分成多个程序?十十、布布局局和和封封包包缺缺陷陷基基础础1代码布局格式和缩排标准是否前后一致?2对于每一个方法,它的代码量是否都不超过规定行数?3对于每一个编译模块,它的代码量是否都不超过规定行数?十十一一、模模块块性性缺缺陷陷 (MO)(MO)重重点点1模模块块( (方方法法, ,类类) )之之间间

8、是是否否具具有有低低偶偶合合性性? ?2每每个个模模块块( (方方法法, ,类类) )自自身身是是否否具具有有高高聚聚合合性性? ?3是否存在重复的代码,它的功能可以通过调用其它方法实现?4Java类库的使用是否合理?十十二二、存存储储器器使使用用缺缺陷陷基基础础1数组是否过大?2数组和对象不再使用之后,它们的引用是否被赋为空值?十十三三、防防御御性性编编程程重重点点1索引和下标是否经过了数组,记录或文件的边界测试2是否验证了导入的数据或输入的参数的正确性和完整性?3所有的输出变量是否都被赋值?4在每个声明中数据是否被正确操作?5分配的内存空间是否都被释放?6对对于于服服务务调调用用是是否否有

9、有超超时时设设计计或或异异常常处处理理? ?8在在程程序序结结束束的的时时候候所所有有的的文文件件或或服服务务是是否否都都保保持持了了正正确确的的状状态态? ?十十四四、性性能能缺缺陷陷 (PE)(PE) 重重点点1是是否否有有更更好好的的数数据据结结构构和和算算法法可可以以采采用用? ?2测试安排是否合理,使易于通过的且代价低廉的测试优先于代价较高且通过频率较低的测试?3是否可以通过对数值进行一次计算并将结果保存来减少对它重新计算带来的消耗?4每一个计算出并保存了的结果是否都被应用?5计算是否能被移到循环之外?是否在循环内频繁创建对象？6在循环内是否有不需要的判断?7短循环是否可以取消?8对

10、同一个数据进行操作的两个循环是否可以合并成一个?9长长连连接接和和短短连连接接是是否否使使用用得得当当? ?十十五五、程程序序安安全全重重点点1是否存在sql注入？2是否存在跨站脚本攻击？3异常页是否泄漏数据库字段等存在安全问题的信息?4cookie中是否存在导致账号被盗等安全问题的信息?十十六六、架架构构设设计计/ /程程序序设设计计附附加加1是否遵循开闭原则?2是否合理使用设计模式?3业务开发的可扩展性、复用性以及组件化4重大历史遗留的解决以及技术突破总总分分评评论论被检查者检查者日 期项目总分得分说明5 55 55 55 5JAVAJAVA代代码码评评审审表表约约定定：总总分分100=1

11、00=基基础础项项5050分分+ +重重点点项项5050分分。附附加加分分上上限限1010分分。针针对对每每一一大大项项评评分分，细细项项作作为为评评分分的的参参考考依依据据。大大项项评评分分小小于于该该项项总总分分的的60%60%或或大大于于该该项项总总分分的的80%80%必必须须给给出出说说明明。如如该该大大项项整整体体不不适适用用，评评分分栏栏填填写写“/”“/”。细细项项中中，带带删删除除线线的的项项可可忽忽略略，加加粗粗项项为为重重点点。变量和常量的命名是否与约定保持一致?是否存在容易混淆的相似的变量和属性名?变量和属性是否书写正确?变量和属性是否被正确的初始化?非局部变量是否能用局

12、部变量替换?所有的for循环的控制变量是否都在循环顶部被声明?是否有应该命名为常量的文字常量?变量和属性是否可以用常量替换?属性是否可以用本地变量?所有的属性是否都有正确的访问限制符(private,protected,public)?是否有静态属性应该是非静态(反之亦然)?方法名的描述方法是否与命名约定一致?每个方法的参数值在使用之前是否都作了检查?对于每一个方法,它是否都返回了正确的值?每种方法是否都有正确的访问限制符(private, protected, public)?静态方法是否应该为非静态(反之亦然)?接口方法的声明是否正确的表达语义？是否正确的给出返回值或抛出异常？每一个类是否

13、都有正确的构造函数?在子类中是否有应该放到父类中的通用成员?类的继承层次是否能被简化?对于每一个数组引用,下标值是否在定义的范围内?对对于于对对象象和和数数组组引引用用, ,是是否否组组确确定定其其值值应应为为非非空空? ?是是否否存存在在大大内内存存对对象象的的频频繁繁创创建建或或引引用用？5 55 55 55 5是否存在不同类型数据之间的混合计算?在计算中是否存在上溢或下溢的可能?关于数值计算的顺序和优先级的假设是否正确?代代码码是是否否避避免免了了对对浮浮点点型型数数值值的的相相等等比比较较操操作作? ?被除数是否做了零值测试和噪音测试?是否用了括号来避免模糊不清?数值类型声明以及精度控

14、制是否合理？数值计算是否存在溢出的可能性？对于每一个循环:是否选用了最佳的循环结构?所所有有的的循循环环是是否否都都能能结结束束? ?如果一个循环有多个出口,是否每个出口都有必要并且得到正确处理?switch声明是否都有default条件?是否所有的case-switch-break对应关系都已更正并加上批注？是否named break叙述都跳到正确的地方？循环和分支的嵌套是否过深?是否正确?是否有if嵌套可以转换程switch嵌套?空控制条件是否都正确，并加上括号及批注？所有的异常是否都得到了正确的处理？每一个方法是否都能结束?文件在被使用之前是否都被打开?输入对象的属性是否与使用的文件一致

15、?在操作文件时是否判断了文件存在与否?文文件件在在被被使使用用之之后后是是否否都都被被关关闭闭? ?网络连接是否合理池化(反之亦然)？网络程序是否有合理的异常处理以及方法的异常声明？网网络络连连接接是是否否正正常常关关闭闭？每一个方法,类和文件是否都有适当的头注释?变量和常量的声明是否都有注释?每个类和方法的潜在行为是否都有用简易的语言进行解释?方法和类的头注释是否和它们的功能保持一致?注释和代码是否保持一致?注释对于理解代码是否有帮助?代码中的注释是否充分?10105 510105 510101010代码中的注释是否过多?代码是否正确完整的实现了设计?代码是否符合相关的编码标准?代码结构是否

16、适当,风格和格式是否保持一致?代码中有没有被调用的或无用的程序,或没有被执行的代码，或者测试代码？代码中是否还有多余的脏程序或测试代码?是否存在能被调用外部复用组件或库函数替代的代码?有没有能被压缩成简单程序的程序块或重复的代码?内内存存及及其其它它资资源源是是否否被被有有效效利利用用? ?数字和字符串常量是否用符号代替?是否有过于复杂的模块需要重新构造或拆分成多个程序?代码布局格式和缩排标准是否前后一致?对于每一个方法,它的代码量是否都不超过规定行数?对于每一个编译模块,它的代码量是否都不超过规定行数?模模块块( (方方法法, ,类类) )之之间间是是否否具具有有低低偶偶合合性性? ?每每个

17、个模模块块( (方方法法, ,类类) )自自身身是是否否具具有有高高聚聚合合性性? ?是否存在重复的代码,它的功能可以通过调用其它方法实现?Java类库的使用是否合理?数组是否过大?数组和对象不再使用之后,它们的引用是否被赋为空值?索引和下标是否经过了数组,记录或文件的边界测试是否验证了导入的数据或输入的参数的正确性和完整性?所有的输出变量是否都被赋值?在每个声明中数据是否被正确操作?分配的内存空间是否都被释放?对对于于服服务务调调用用是是否否有有超超时时设设计计或或异异常常处处理理? ?在在程程序序结结束束的的时时候候所所有有的的文文件件或或服服务务是是否否都都保保持持了了正正确确的的状状态态? ?是是否否有有更更好好的的数数据据结结构构和和算算法法可可以以采采用用? ?测试安排是否合理,使易于通过的且代价低廉的测试优先于代价较高且通过频率较低的测试?是否可以通过对数值进行一次计算并将结果保存来