代码走查标准

合集下载
  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

一.目录文件组织

1.所有的文件名符合文件命名规范

2.文件和模块分组清晰

二.程序结构

3.所有的模块(函数和外部接口)定义清晰,模块分解清楚

4.结构设计能够满足机能变更,便于重构

5.模块中所有的数据结构都定义为局部的,并且通过定义好的函数进行访问

6.为外部定义了良好的函数接口,且修改时不影响其他代码模块

7.代码体系构架对空间和速度都已经进行考虑

三.代码组织

8.所有的代码行在80字符以内

9.每个程序文件都小于2000行

10.每个函数显示不超过100行

11.所有的变量声明每行只声明一个

12.所有的变量名都小于32字符

13.所有的函数名都小于64个字符

14.每个函数之间都用空行进行分开

15.所有的行每行最多只有一句代码或一个表达式

四.函数

16.函数注释清楚地描述函数和它的功能

17.函数的名字清晰的定义了它的目标以及函数所做的事情

18.函数的参数遵循一个明显的顺序

19.函数由并列关系的语句组成

20.函数高内聚,只做一件事情,并做好

21.所有的参数小于7个,且都被使用

22.函数使用了最少数目的return语句

23.函数检查了输入数据的合法性

24.函数异常处理清楚

25.函数设计已经考虑了将来的变化

五.数据类型与变量

26.Plugin中尽量避免全局变量的使用

27.每一个变量都在接近使用它的地方才初始化

28.变量的命名完全、明确的描述了该变量代表什么

29.同一种类型命名使用统一的前缀

30.所有的变量都被使用

31.所有的数组访问要考虑越界情况

32.变量在使用前进行必要的null值判断和处理六.条件判断

33.普通的情况在if下处理而不是else

34.最常用的情况最先判断

35.嵌套层次小于3层

七.循环

36.当有明确的多次循环操作,使用For循环

37.当有不明确的多次循环操作,while循环被使用

38.变量定义,数据库读写尽量在循环外进行

39.循环嵌套的次数小于3次

八.注释

40.使用统一的注释模版

41.每个类,每个函数都要有注释

42.注释量不低于20%

43.注释要随着代码改变而进行更新

九.其他

44.无用的代码和注解已经删除

45.页面的布局要符合统一操作说明

相关文档
最新文档