代码走查标准.doc

《代码走查标准.doc》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、一．目录文件组织1.所有的文件名符合文件命名规范2.文件和模块分组清晰二．程序结构3.所有的模块（函数和外部接口）定义清晰，模块分解清楚4.结构设计能够满足机能变更，便于重构5.模块中所有的数据结构都定义为局部的，并且通过定义好的函数进行访问6.为外部定义了良好的函数接口，且修改时不影响其他代码模块7.代码体系构架对空间和速度都已经进行考虑三．代码组织8.所有的代码行在80字符以内9.每个程序文件都小于2000行10.每个函数显示不超过100行11.所有的变量声明每行只声明一个12.所有的变量名都小于32字符13.所有的函数名都小于64个字符14.每个函数之间都用空行进行分开15.所有的行

2、每行最多只有一句代码或一个表达式四．函数16.函数注释清楚地描述函数和它的功能17.函数的名字清晰的定义了它的目标以及函数所做的事情18.函数的参数遵循一个明显的顺序19.函数由并列关系的语句组成20.函数高内聚，只做一件事情，并做好21.所有的参数小于7个，且都被使用22.函数使用了最少数目的return语句23.函数检查了输入数据的合法性24.函数异常处理清楚25.函数设计已经考虑了将来的变化五．数据类型与变量1.Plugin中尽量避免全局变量的使用2.每一个变量都在接近使用它的地方才初始化3.变量的命名完全、明确的描述了该变量代表什么4.同一种类型命名使用统一的前缀5.所有的变量都被

3、使用6.所有的数组访问要考虑越界情况7.变量在使用前进行必要的null值判断和处理六．条件判断8.普通的情况在if下处理而不是else9.最常用的情况最先判断10.嵌套层次小于3层七．循环11.当有明确的多次循环操作，使用For循环12.当有不明确的多次循环操作，while循环被使用13.变量定义，数据库读写尽量在循环外进行14.循环嵌套的次数小于3次八．注释15.使用统一的注释模版16.每个类，每个函数都要有注释17.注释量不低于20%18.注释要随着代码改变而进行更新九．其他19.无用的代码和注解已经删除20.页面的布局要符合统一操作说明