JavaScript编码规范-参考资料.docx

JavaScript编码规范

第PAGE4页

产品源代码质量检测：JavaScript

编码规范

(A0)

目录

TOC\o1-4\h\z\u前言 IV

1概述 1

2文件引用及参考 1

3声明规则 1

3.1变量 1

3.2函数 3

4命名规则 4

4.1构造函数/类 4

4.2变量/对象属性 4

4.3常量 5

4.4命名空间 5

4.5函数/对象方法 5

4.6事件 6

5注释规则 6

5.1通用注释规则 6

5.2JavaScript文件注释 7

5.3函数/方法注释 7

5.4变量/属性注释 8

6排版规则 8

6.1文件结构 8

6.2缩进 8

6.3分号 9

6.4空格 9

6.5行排版 9

6.6空行 9

6.7语句 10

6.7.1表达式语句 10

6.7.2复合语句 10

6.7.3if-else语句 10

6.7.4for语句 10

6.7.5for-in语句 10

6.7.6while语句 10

6.7.7do-while语句 11

6.7.8switch语句 11

6.7.9try-catch-finally语句 11

7字符集编码规则 11

8编码健壮性遵循原则 11

8.1合理使用闭包 11

8.2合理使用for和for-in循环 12

8.3避免无限循环 13

8.4区分===和== 13

8.5禁止使用with(){} 13

8.6字符串拼接 13

8.7避免在函数中定义全局变量 14

8.8避免在JavaScript中包含过多的HTML、CSS内容 14

8.9异常处理 14

9安全 15

9.1JSON串的安全过滤 15

9.2JavaScript脚本攻击 15

9.3Cookie泄露 15

9.4防止js代码泄露 15

10性能优化 15

10.1合理使用prototype 15

10.2本地缓存对象属性 15

10.3减少操作HTMLDOM结构的次数 16

10.4引用JavaScript文件 16

10.5事件代理 16

11第三方框架引入规范 16

12安全性要求 16

13附录 16

13.1一致性约束 16

13.2保留字 17

13.3JSON格式 18

13.4常用类型值举例 19

13.5数据处理建议 20

13.5.1数据处理控件 20

13.5.2数据格式与处理 20

13.5.3缓存使用 20

JavaScript编码规范

概述

本规范适用于公司产品JavaScript程序开发。

文件引用及参考

《JavaScript权威指南V5》。

《JavaScript高级程序设计V2》。

《JavaScript高性能》。

《GoogleJavaScript开发规范》。

《国家电网公司JavaScript编码规范》。

声明规则

变量

局部变量和全局变量均使用var关键字进行声明。

示例:

varname=””;

在同一作用域（在JavaScript中共三种作用域：全局作用域、局部作用域、嵌套局部作用域）的起始位置声明变量，避免出现重复声明变量，for、for-in语句的循环变量除外。

示例:

//全局变量

varglobalV=”global”;

functionprintUserProperty(){

//局部变量

varusers=[{name:”用户1”},{name:”用户2”}];

//for语句变量i,user

for(vari=0,user;user=users[i];i++){

printUserProperty(user);

}

functionprintUserProperty(user){

//嵌套局部变量

varcount=10;

//for-in语句变量prop

for(varpropinuser){

alert(prop);

}

}

}

声明全局变量、对象属性、函数参数时需注释变量类型并赋初值(通过初值确定变量类型)，由于局部变量是在代码块内部定义，作用范围