JavaScript规范(初稿).docx

JavaScript程序开发规范
目录
1. 文档目的 4
2. 适用范围 4
3. JavaScript编码规范 4
基本原则 4
引入文件 4
命名规范 5
变量声明 5
方法声明 5
变量命名 6
方法命名 6
常用命名词汇中英对照表 6
排版规范 8
行宽 8
行结束 9
换行 9
缩进 9
空格的用法 11
空行的使用 13
常用语句标准格式 15
注释规范 19
代码规范 19
数组定义 20
额外的建议 22
修订文档历史记录
日期
版本
修订说明
修订人
审核人
批准人
2013/1/4

yangxueyong
文档目的
为规范JavaScript技术,增强代码质量的控制、管理制定此规范。
适用范围
Web前段页面开发。
JavaScript编码规范
编码规范对于程序而言尤为重要,因为:
一个软件的生命周期中,80%的花费在于维护
几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护
编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码
如果你将源码作为产品发布,就需要确任它是否被很好的打包并且清晰无误,一如你已构建的其它任何产品
每个开发人员必须严格遵守编码规范。
基本原则
一致性:保证整个产品编码风格的一致,无论是开发一始还是后期维护,整个规范的遵守贯穿整个软件生命周期。
简易性:构建类和方法力求简单,提高代码的可读性和可维护性。
清晰性:确保每一个类、接口、方法、变量和对象都有清楚的功能。
健壮性:确保程序健壮,要为错误和异常提供可预见的处理,不能隐藏错误和异常。
高效性:编码时除了实现功能,还要兼顾代码内存的使用、程序运行的效率。
引入文件
JavaScript 的文件中,需要调用的时候在 HTML 中以<script src=""> 的形式包含进来。JavaScript 代码若不是该 HTML 文件所
专用的,则应尽量避免在 HTML 文件中直接编写 JavaScript 代码。因为这样会大大增加 HTML 文件的大小,无益于代码的压缩和缓存的使用。
另外,<script src=""> 标签应尽量放在文件的后面。这样会降低因加载 JavaScript 代码而影响页面中其它组件的加载时间。没有必要使用
language或者type属性。由服务器而不是script标签来决定MIME类型。
当引入文件很多时,可以考虑将所有引入文件单独放在一个文件中,然后包含进来。
命名规范
给变量和函数取一个确切的名字,不要随便命名。
名字应该能够标识事物的特性,而且尽量不使用缩写,除非是众所周知的。
非构造函数采用驼峰命名法,尽量采用动宾结构getName,以与变量名相区别。
构造函数(即自定义类型)名称首字母大写
4 、变量采用驼峰命名法
变量声明
1、所有的变量应该在使用前声明。JavaScript不强求这点,但是这样做会让程序更易读,并且会让探测未声明的可能变成隐式的globals的
变量更容易。
2、var语句应该为方法体内的第一个语句。
3、每个变量声明应该自己占一行并有注释。它们应该按字母顺序排列。
4、尽量少使用全局变量。隐式的全局变量应该从来不使用。
方法声明
所有的方法应该在它们使用前声明。内部方法应该位于var语句后面。这让哪些变量包含在它的scope里更清楚。
方法名和参数列表的“(”(左圆括号)之间不应该有空格。在“)”(右圆括号)和“{”(左大括号)之间有一个空格。
方法体本身缩进4个空格。“}”(右大括号)应该和方法声明处对齐。
如果一个方法字面量为匿名的,则在“function”和“(”(左圆括号)之间应该有一个空格。如果省略空格,则它可能看起来方法名是“function”,而这是错误的。
尽量少用全局方法。
变量命名
命名应该由26个大小写字母(A .. Z, a .. z),10个数字(0 .. 9)和_(下划线)组成。
不要使用_(下划线)作为名字的首字母。它有时被用来表示私有,但是它实际上不提供私有性。
大多数变量和方法名应该以小写字母开始。
必须使用new前缀的构造函数应该以大写字母开始。JavaScript不会在省略new时报编译期警告或运行时警告。
全局变量应该全部使用大写字母。(JavaScript没有宏或常量,所以没有多少要求使用大写字母来表示JavaScript的特性的场景)
方法命名
1、方法名的定义应该使用有意义的标识符。
2、命名时遵循驼峰命名法(Camel-Case), 即当名字由多个