|
|
1
|
+# JavaScript代码规范
|
|
|
2
|
+
|
|
|
3
|
+## 行的长度
|
|
|
4
|
+每行长度不应该超过**120**个字符,如果一行多余120个字符,应该在一个运算符后换行,下一行增加**2**级缩进,即8个空格)
|
|
|
5
|
+```
|
|
|
6
|
+doSomething(argument1, argument2, argument3, argument4,
|
|
|
7
|
+ argument5);
|
|
|
8
|
+```
|
|
|
9
|
+## 运算符间距
|
|
|
10
|
+二元运算符前后必须使用一个空格保持表达式的整洁,操作符包括赋值运算符和逻辑运算符
|
|
|
11
|
+```
|
|
|
12
|
+var name = 'xuqi'; // GOOD
|
|
|
13
|
+var name='xuqi'; // BAD
|
|
|
14
|
+```
|
|
|
15
|
+## 括号间距
|
|
|
16
|
+当使用括号时,紧接左括号之后和紧接右括号之前不应该有空格。
|
|
|
17
|
+```
|
|
|
18
|
+doSomething(arg); // GODD
|
|
|
19
|
+doSomething( arg ); // BAD
|
|
|
20
|
+```
|
|
|
21
|
+## 变量声明
|
|
|
22
|
+* 所有变量在使用前应该先定义
|
|
|
23
|
+* 变量定义应该放在函数开头
|
|
|
24
|
+* 使用var,const,let表达式定义变量,每行定义一个
|
|
|
25
|
+* 除了首行,所有行都应该多一层缩进使变量声明对齐
|
|
|
26
|
+* 初始化的变量放在未初始化的变量之前
|
|
|
27
|
+* 所有的变量命名必须使用英文单词
|
|
|
28
|
+* 浮点变量必须指明实部(即便以0.开头)和小数点后一位
|
|
|
29
|
+
|
|
|
30
|
+```
|
|
|
31
|
+var name = 'xuqi',
|
|
|
32
|
+ age,
|
|
|
33
|
+ sex,
|
|
|
34
|
+ ...;
|
|
|
35
|
+
|
|
|
36
|
+const $ = require('yoho.jquery');
|
|
|
37
|
+
|
|
|
38
|
+let i;
|
|
|
39
|
+```
|
|
|
40
|
+
|
|
|
41
|
+另外,晦涩的变量名最好给出注释,否则别人很难读懂接下来代码的意思。
|
|
|
42
|
+
|
|
|
43
|
+## 函数声明
|
|
|
44
|
+* 函数在使用前应该先定义
|
|
|
45
|
+* 函数名和开始圆括号之间无空格(包括匿名函数的function关键字与圆括号之间)
|
|
|
46
|
+* 开始圆括号和结束圆括号之间无空格
|
|
|
47
|
+* 参数名之间应该在逗号之后保留一个空格
|
|
|
48
|
+* 开始花括号应该同function关键字保持同一行,结束圆括号和开始花括号之间应该保留一个空格
|
|
|
49
|
+* 函数体保持一级缩进
|
|
|
50
|
+
|
|
|
51
|
+```
|
|
|
52
|
+function doSomething(arg1, arg2) {
|
|
|
53
|
+ doThing1();
|
|
|
54
|
+ doThing2();
|
|
|
55
|
+}
|
|
|
56
|
+
|
|
|
57
|
+const method = function() {
|
|
|
58
|
+ doSomething();
|
|
|
59
|
+};
|
|
|
60
|
+```
|
|
|
61
|
+另外,IIFE的标准格式也在这里指出:
|
|
|
62
|
+```
|
|
|
63
|
+(function(args) {
|
|
|
64
|
+ //
|
|
|
65
|
+}(args)); //(args)位于外层括号内
|
|
|
66
|
+```
|
|
|
67
|
+
|
|
|
68
|
+## 对象直接量
|
|
|
69
|
+* 起始左括号应该与表达式保持一行
|
|
|
70
|
+* 每个属性的键名前保持一个缩进,第一个属性应该在左括号后另一起行
|
|
|
71
|
+* 每个属性的键名不包含引号,其后跟一个冒号(前无空格,后有空格),然后是值
|
|
|
72
|
+* 如果属性值为函数,函数体应该在属性名之下另起一行,并且其前后均应保留一个空行
|
|
|
73
|
+* 一组相关属性的前后插入空行以提高代码的可读性
|
|
|
74
|
+* 结束的右括号独占一行
|
|
|
75
|
+
|
|
|
76
|
+```
|
|
|
77
|
+var person = {
|
|
|
78
|
+ name: 'xuqi',
|
|
|
79
|
+ age: 25,
|
|
|
80
|
+
|
|
|
81
|
+ groupAttr1: xx1,
|
|
|
82
|
+ groupAttr2: xx2,
|
|
|
83
|
+
|
|
|
84
|
+ walk: function() {
|
|
|
85
|
+ //your walk fn
|
|
|
86
|
+ }
|
|
|
87
|
+};
|
|
|
88
|
+```
|
|
|
89
|
+
|
|
|
90
|
+* 当对象字面量作为函数参数时,起始括号应该与函数名同行
|
|
|
91
|
+
|
|
|
92
|
+```
|
|
|
93
|
+doSomething({
|
|
|
94
|
+ //do something
|
|
|
95
|
+});
|
|
|
96
|
+```
|
|
|
97
|
+
|
|
|
98
|
+## 命名
|
|
|
99
|
+### 变量:
|
|
|
100
|
+* 采用小驼峰命名格式
|
|
|
101
|
+* 变量命名为名词(区别函数)
|
|
|
102
|
+* 变量中不使用_
|
|
|
103
|
+
|
|
|
104
|
+### 函数:
|
|
|
105
|
+* 采用小驼峰命名格式
|
|
|
106
|
+* 函数命名为动词(区别变量)
|
|
|
107
|
+* 函数名中不使用_
|
|
|
108
|
+
|
|
|
109
|
+### 构造函数:
|
|
|
110
|
+* 采用大驼峰命名格式
|
|
|
111
|
+* 命名应该是名词
|
|
|
112
|
+
|
|
|
113
|
+### 私有成员:
|
|
|
114
|
+* 一个对象中不希望外部访问的以下划线开头(约定)
|
|
|
115
|
+
|
|
|
116
|
+## 等号运算符
|
|
|
117
|
+使用`===`和`!==`,禁止使用`==`和`!=`
|
|
|
118
|
+
|
|
|
119
|
+## undefined
|
|
|
120
|
+禁止使用`name === undefined`判断一个变量是否定义。应该使用`typeof(name) === 'undefined'`;
|
|
|
121
|
+
|
|
|
122
|
+## 常用语句规范
|
|
|
123
|
+### if语句
|
|
|
124
|
+```
|
|
|
125
|
+if (condition) {
|
|
|
126
|
+ doSomething();
|
|
|
127
|
+} else if (condition1) {
|
|
|
128
|
+ doSomething2();
|
|
|
129
|
+} else {
|
|
|
130
|
+ soOtherThing();
|
|
|
131
|
+}
|
|
|
132
|
+```
|
|
|
133
|
+### for语句
|
|
|
134
|
+```
|
|
|
135
|
+// GOOD
|
|
|
136
|
+var i;
|
|
|
137
|
+for (i = 0; i < len; i++) {
|
|
|
138
|
+ doSomething();
|
|
|
139
|
+}
|
|
|
140
|
+for (i in collection) {
|
|
|
141
|
+ if (collection.hasOwnProperty(i)) {
|
|
|
142
|
+ doSomething();
|
|
|
143
|
+ }
|
|
|
144
|
+}
|
|
|
145
|
+
|
|
|
146
|
+// BAD
|
|
|
147
|
+for (var i = 0; i < len; i++) {
|
|
|
148
|
+ doSomething();
|
|
|
149
|
+}
|
|
|
150
|
+for (i in collection) {
|
|
|
151
|
+ doSomething();
|
|
|
152
|
+}
|
|
|
153
|
+```
|
|
|
154
|
+### while,do语句
|
|
|
155
|
+```
|
|
|
156
|
+while (condition) {
|
|
|
157
|
+ doSomething();
|
|
|
158
|
+}
|
|
|
159
|
+
|
|
|
160
|
+do {
|
|
|
161
|
+ doSomething();
|
|
|
162
|
+} while (condition)
|
|
|
163
|
+```
|
|
|
164
|
+
|
|
|
165
|
+### switch语句
|
|
|
166
|
+* 每一个case保持一个缩进
|
|
|
167
|
+* 每一组语句都应该以break,return等结尾,或者用一行注释表示跳过(falling through)
|
|
|
168
|
+* 无default的情况也要注释特别说明
|
|
|
169
|
+
|
|
|
170
|
+```
|
|
|
171
|
+switch (val) {
|
|
|
172
|
+ case 1:
|
|
|
173
|
+ //nothing
|
|
|
174
|
+ case 2:
|
|
|
175
|
+ doSomething();
|
|
|
176
|
+ break;
|
|
|
177
|
+ default:
|
|
|
178
|
+ doDefault();
|
|
|
179
|
+}
|
|
|
180
|
+```
|
|
|
181
|
+
|
|
|
182
|
+### try语句
|
|
|
183
|
+```
|
|
|
184
|
+try {
|
|
|
185
|
+ doSomething();
|
|
|
186
|
+} catch (err) {
|
|
|
187
|
+ doSomething2();
|
|
|
188
|
+} finally {
|
|
|
189
|
+ doSomething3();
|
|
|
190
|
+}
|
|
|
191
|
+```
|
|
|
192
|
+
|
|
|
193
|
+## 模块化规范
|
|
|
194
|
+* 模块开头require加载所有依赖模块
|
|
|
195
|
+
|
|
|
196
|
+```
|
|
|
197
|
+var $ = require('yoho.jquery'),
|
|
|
198
|
+ flip = require('../plugin/flip'); //普通文件
|
|
|
199
|
+
|
|
|
200
|
+require('../plguin/login');
|
|
|
201
|
+```
|
|
|
202
|
+
|
|
|
203
|
+* 模块抛出接口应该给予注释说明功能和使用方法 |