Javascript语言编程规范
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
JavaScript 语言编码规范
1 范围 (2)
2 术语和定义 (2)
3 JavaScript 文件引用 (2)
4 代码排版 (2)
4.1 行长度 (2)
4.2 行结束 (3)
5 缩进 (3)
6 注释 (4)
7 标识符命名 (5)
8声明 (5)
8.1变量的声明 (5)
8.2 函数的声明 (6)
9 语句 (7)
10 特殊符号 (9)
10.1 空白符 (9)
10.2 加号 (10)
1 范围
本规范规定了使用JavaScript语言编程时排版、命名、声明、作用域、及一些特殊符号的规则和建议。
本规范适用于使用JavaScript语言编程的产品和项目。
2 术语和定义
规则:编程时强制必须遵守的原则。
建议:编程时必须加以考虑的原则。
格式:对此规范格式的的说明。
说明:对此规范或建议进行必要的解释。
实例:对此规范或建议从正、反两个方面给出的例子。
3 JavaScript 文件引用
JavaScript 程序应该尽量放在 .js 的文件中,需要调用的时候在HTML 中以
5 缩进
关于缩进的问题,不只是JavaScript,几乎所有的语言编写的时候,都会提及缩进的问题。缩进几乎是代码编写规范的第一课,是代码可阅读性判断的直接因素。
代码缩进的好处是不言而喻的,但是对于如何缩进,则没有标准而言。最受欢迎的是方便使用TAB 键缩进,也有些喜欢用 2 个、4 个、8 个空格进行缩进。这样缩进风格不一,也同样给代码的阅读带来障碍。
本文提倡用 4 个空格来进行缩进,并在同一产品中采用同一种缩进标准。不支持用TAB 键进行缩进。这是因为直到现在还没有统一的标准来定义TAB 键所代替的空白大小,有些编辑器解析为 4 个空格大小,有些则解析为8 个。因而用不同的编辑器查看代码,可能造成格式混乱。当然TAB 简单易用,为解决这个问题,建议在设置开发环境时,将编辑器里的TAB 快捷键重新设置为 4 个空格。据了解Eclipse, Vi, Nodepad++,Editplus, UltraEdit 等流行的编辑器,均提供了此功能。
6 注释
代码中的注释很重要,自然也是毋庸置疑的。通常我们会强调代码中注释数量的多少,而轻视了对注释质量的提高。编码是及时添加注释,会给后续代码的维护人员带来很大的便利。但是如果注释不注意更新,或者由于拷贝、粘贴引起的错误的注释,则会误导阅读人员,反而给阅读带来障碍。
除了注释要及时更新外,我们还应对注释的内容要特别关注。注释要尽量简单、清晰明了,避免使用含混晦涩的语言,同时着重注释的意义,对不太直观的部分进行注解。请见示例。
示例:
1.
2. //following section is used to initialize golbal variables (good)
3. var valueA = 0; //initialize valueA to be sero (bad)
4. var valueB = 1;
5. ...
6. //call f1 function after waiting for 50 seconds. (good)
7. setTimeout(f1,50000); //set timeout to be 20s (copy error)
8. ...
9.