代码走查检查表.doc

代码走查检查表
评审日期:年月日
评审对象
作者
评审人
评审工作量
序号
检查项
评审意见
走查前准备
1
得到一份解释代码的最新的设计文档 ,作为代码走查的参考    
2
代码都已提交,版本统一  
程序结构组织 
1
所有代码的结构清晰,具有良好的结构外观和整齐
2
所有的模块(函数和外部接口)定义清晰,模块分解清楚 
3
所有的功能需求都明显的覆盖
4
整个代码体系结构组合合理 ,分层清晰,代码之间功能划分明确
5
所有的接口模块化,尽量减少接口之间的耦合度,修改时尽量不影响其他代码模块      
6
代码体系构架对空间和速度都已经进行考虑    
7
数据库操作、IO操作等是否正确关闭资源。并且必须在try -catch-finally 的finally中关闭。
8
一个业务如果进行多次数据库更新、添加、删除是否正确添加事务。
9
进行逻辑与、逻辑或判断时是否使用短路与、短路或。
10
多处使用相同代码时,应定义唯一方法或变量以供使用。
11
对象是否使用工厂获取。
12
导入类时,如果仅使用包中的几个类,应导入具体类,而不是导入整个包。
13
数组声明的时候使用 int[] index ,而不要使用 int index[]。
14
代码实现的逻辑是否与详细设计描述的逻辑一致
15
检查类中是否有无效的代码或者是无用的代码。
16
(),需要进行日志处理
17
所有的文件名符合文件命名规范,见名知意 
18
文件和模块分组清晰       
19
较长的语句、表达式或参数(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读
20
每个程序文件都小于2000行 
代码组织 
1
数据库查询语句不要出现select *
2
对需要处理的字符串定义为StringBuffer ,常量定义成静态的。
3
所有的变量名都小于32字符    
4
有返回值的方法是否正确返回。Return语句应定义在方法结尾处。
5
代码排版是否规范。
6
所有的行每行最多只有一句代码或一个表达式    
7
复杂的表达式具备可读性,添加注释说明,表达式结构清晰 
8
续行缩进 
9
括号在合适的位置    
10
每个顺序的小块用空行隔开 
11
注释和代码对齐或接续在代码之后 
12
JSP必须不能有basepath。
13
JSP引用js全部要有path
14
JSP用的标签库是否都正确引用。
15
JSP写的js方法必须要有注释。
代码是否可读。
16
代码的逻辑是否有问题。
17
JSP页面尽量不要写过多的隐藏域。
18
JSP页面要注意排版、必要的注释、尽量减少使用alert(),JS
和CSS除非必要就放到外部的单独文件中,在JSP中引用。
19
实例变量是否使用private修饰并定义getter、setter方法。
20
连接数据库的方法必须调用公用的方法。
21
异常要统一处理,异常处理方法是否符合项