javascript代码审查表

《javascript代码审查表》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、JavaScript代码审查表版本：0.3作者：xel创建日期：2006-04-23最后修改日期：2006-05-20使用说明本审查表在对JavaScript源代码进行审查时使用，每次审查时，审查者将本审查表打印一份，并填写相应内容。需要注意的是，对每项检查内容，都需要将代码从头至尾检查一遍，即如果有20项检查内容，就需要查看20次源代码。查看源代码时，只需要看是否符合检查项的要求，不考虑任何对源代码修改的问题，修改工作由代码编写者完成。第16页共16页审查表审查人审查日期审查内容（被审查文件的作用）被审查文件所属的项目被

2、审查文件在项目中的路径1.审查准备工作审查项目说明通过否（通过打“√”，未通过即留空白）说明（用于描述不清楚的问题或者有条件通过的情况）1.1.应准备最新版本的审查表。1.2.应准备最新版本的编码规范。编码规范版本号：1.3.要审查的JavaScript源代码应为需要审查的版本。JavaScript源代码版本号为：1.4.要审查的HTML文件应为需要检查的版本。HTML文件的版本号为：2.源代码编码风格审查项目说明通过否说明（列出未通过审查的行号和文件名）第16页共16页2.1.变量名、常量名、类名、类的属性名应符合编码规

3、范要求。2.2.方法名的命名应符合编码规范的要求。2.3.缩进、花括号、折行的排版应符合编码规范的要求。2.4.空格、空行应符合编码规范的要求。2.5.超过10行（不计空行、函数定义、仅包括花括号的行）的源代码应有相应的块注释描述其目的（而非实现方法）。2.6.定义变量的语句除for循环的循环变量定义外，每行应仅定义一个变量。3.文件引用审查项目说明通过否说明（列出未通过审查的行号和文件名）3.1.应在每个js文件开头加入DEBUG=true语句。该语句将使得assert、dalert函数均出于调试工作状态中。第16页共1

4、6页3.2.如果文件中定义了公用的类，每个文件应仅定义了一个公用类。3.3.源代码中引用的其他文件中的方法、类应使用项目公用目录下的定义。在项目中，每个用例仅使用一个js文件，其余需要引用的方法、类、变量，全部在公共目录中定义。4.功能审查项目说明通过否说明（列出未通过审查的行号和文件名）4.1.方法的功能应明确。包括方法的入口参数的含义是否明确（即审查是否能够看懂）？方法的返回值是否明确？方法对其他资源产生的影响（如修改了HTML文档中的对象、修改了XML对象、修改了全局变量或对象等）是否在注释中（而不仅仅是在代码中）明

5、确？4.2.方法的块注释应保证了方法完成了其所有功能。4.3.方法的块注释应保证了方法没有做任何不应由本方法做的工作。即方法没有做任何方法定义说明中没有说明的工作。第16页共16页4.4.块注释后的源代码应保证完成块注释所声明的工作。4.5.块注释后的源代码应保证没有做任何块注释未声明的工作。5.变量审查项目说明通过否说明（列出未通过审查的行号和文件名）5.1.一个变量的不同取值范围不应代表3个或以上不同的含义。例如，整型变量iValue在>0时，表示某个索引值，在=0时表示未知值，在<0时表示方法调用失败，这样iValu

6、e变量就代表了3个含义，这是应该避免发生的。5.2.布尔变量的命名应采用肯定形式，除非否定的含义更为明确，或者可以简化代码结构。如，应使用isValid而不是isNotValid作为布尔变量名。5.3.在selectSingleNode(path).xxx语句前，应保证selectSingleNode(path)的取值不为空。第16页共16页5.4.出现xxx.yyy.zzz这样的连续引用属性的语句时，应确保xxx、xxx.yyy、xxx.yyy.zzz均不为空。5.5.其他变量和属性在被引用前，应确保其被初始化。5.6.

7、应使用WEBAPI中自定义的getCollection方法对HTMLelement对象和TextNode对象的children、all、childNodes方法返回值进行预处理。HTMLelement对象和TextNode对象在只有一个子节点的情况下，其children等方法返回的是一个表示子节点的对象，而不是一个包含子节点对象的数组，因此，需要用getCollection方法进行预处理，确保使用的是一个数组对象。getCollection方法在WEBAPI的SysUtil.js文件中定义。5.7.不应调用由cloneNo

8、de方法产生的TR对象的cells方法获取其TD子节点。5.8.如果xxx.yyy.zzz这样的连续引用应该不会出现任何问题，应使用assert语句确保这一点满足。如，应使用以下语句序列：assert(a!=null,“…”);assert(a.b!=null,“…”);c=a.b+d;第16页共16页