Javascript代码规范Word文件下载.docx
《Javascript代码规范Word文件下载.docx》由会员分享,可在线阅读,更多相关《Javascript代码规范Word文件下载.docx(11页珍藏版)》请在冰豆网上搜索。
3.所有的二元操作符,除了“.”(圆点)、“(”(左圆括号)和“[”(左中括号),都应该使用一个空格来和操作数隔开。
4.一元操作符和操作数之间不应该使用空格隔开,除了操作符是一个单词时,如typeof。
5.for语句控制部分的每个“;
”(分号)应该在后面跟一个空格。
6.每个“,”(逗号)后面应该跟一个空格。
2.2.缩进
缩进的最小单位是4个空格,4个空格为一个缩进单位。
不要使用tab键,一个函数的开始顶格写,进入函数体之后缩进一个单位,进入下一层再缩进一个单位,以此类推,例子如下:
FunctiongetAttr()
{
For(varI=0;
I<
n;
i++)
Alert(“hello”);
}
所有的“{”和“}”必须缩进的距离都一样,不能出现左括号缩进2个字符,右括号缩进4个字符这样缩进不等的情况。
2.3.行宽
不要让一行代码超过80个字符。
当一条语句不能在单独一行写完时,可能有必要拆分它。
在操作符后进行拆分,最好是在逗号后面拆分。
操作符后面进行拆分减少了通过插入分号伪装copy-paste错误的可能性。
下一行应该缩进8个空格。
2.4.注释
每一个函数的开头都应该写上注释,注释的格式为:
/*
此函数用于在获取标签字符串之后对该标签进行计息
参数str表示…
*/
(2)对于新定义变量的用途以及关键的语句必须进行单行注释,注释添加的位置可以在上一行,也可以在行末,视情况而定,如果一个语句较长,推荐在上一行进行注释;
如果语句较短可以在行末进行注释。
(3)对于一个函数的结尾,应该在结尾处加上此函数结束的标志用于表示函数的结束,例如:
//endoffunctiongetAtrr
(4)对于有多层嵌套,应该在最外层以及具有关键意义的层的结尾处添加结束注释,例如:
For(varI=…)
Varj=0;
…
If(…)
For(vart…)
}//endofif
}//endoffor
更新注释非常重要,修改后的代码应该及时的更新注释,函数功能转变了应该及时的更新函数头的注释。
(5)让注释有意义。
更多的关注于不能马上可见的东西。
不要用如下内容浪费读者的时间:
i
=
0;
//
Set
to
zero.
一般使用行注释。
把块注释用于正式文档或外部注释。
2.5.变量声明
(1)所有的变量应该在使用前声明,并添加用途注释。
(2)在方法体内进行变量声明必须让var语句成为方法体内的第一个语句。
var
currentEntry;
currentyly
selected
table
entry
level;
indentation
level
size;
size
of
table
(3)尽量少使用全局变量,隐式的全局变量应该从来不使用。
2.6.方法声明
所有的方法应该在它们使用前声明。
内部方法应该位于var语句后面。
这让哪些变量包含在它的scope里更清楚。
方法名和参数列表的“(”(左圆括号)之间不应该有空格。
在“)”(右圆括号)和“{”(左大括号)之间有一个空格。
方法体本身缩进4个空格。
“}”(右大括号)应该和方法声明处对齐。
function
outer(c,
d)
e
c
*
d;
inner(a,
b)
return
(e
a)
+
b;
}
inner(0,
1);
这个规范可以和JavaScript很好的工作,因为在JavaScript里方法和对象字面量可以放在允许表达式的任何位置。
它使用内部方法和复杂结构提供最好的可读性。
getElementsByClassName(className)
results
[];
walkTheDOM(document.body,
(node)
a;
array
class
names
node.className;
the
node'
s
classname
i;
loop
counter
If
node
has
a
name,
then
split
it
into
list
simple
names.
any
them
match
requested
append
set
results.
if
(c)
c.split('
'
);
for
(i
a.length;
+=
1)
(a[i]
===
className)
results.push(node);
break;
});
results;
如果一个方法字面量为匿名的,则在“function”和“(”(左圆括号)之间应该有一个空格。
如果省略空格,则它可能看起来方法名是“function”,而这是错误的。
div.onclick
(e)
false;
};
that
method:
()
this.datum;
datum:
尽量少用全局方法。
2.7.命名规则
命名应该由26个大小写字母(A..Z,a..z),10个数字(0..9)和_(下划线)组成。
不要使用国际字符,因为它们可能不易读或者不能在任何地方都能容易理解。
不要在名字里使用$(美元符号)或\(反斜线符号)。
不要使用_(下划线)作为名字的首字母。
它有时被用来表示私有,但是它实际上不提供私有性。
如果私有性很重要,使用提供私有性的
privatemembers。
Avoidconventionsthatdemonstratealackofcompetence.
大多数变量和方法名应该以小写字母开始。
必须使用new前缀的构造函数应该以大写字母开始。
JavaScript不会在省略new时报编译期警告或运行时警告。
不使用new时会发生坏事情,所以大写首字母规范是我们拥有的唯一的防御。
全局变量应该全部使用大写字母。
(JavaScript没有宏或常量,所以没有多少要求使用大写字母来表示JavaScript的特性的场景)
3.语句的规范
3.1.简单语句
每行应该包含至少一个语句。
在每个简单语句末尾添加一个“;
”(分号)。
注意一个给方法或对象赋值的赋值语句仍然是一个赋值语句,所以也必须以分号结尾。
JavaScript允许任何表达式作为语句使用。
这可能产生一些错误,特别是在插入分号时。
唯一可以当作语句使用的表达式是赋值表达式和调用表达式。
3.2.复杂语句
复合语句是包含一个用“{}”(大括号)包围语句列表的的语句。
1,包围的语句应该再缩进4个空格。
2,“{”(左大括号)应该位于开始复合语句的行的末尾。
3,“}”(右大括号)应该新起一行并且和相匹配的“{”所在那行的起始位置对齐
4,当语句是控制结构的一部分时,所有语句都应该用括号包围,即使是单行语句,例如if或for语句。
这让添加语句更容易而且不会引起bug。
3.3.语句实例
3.3.1.return语句
具有值的return语句不应该使用“()”(圆括号)包围值。
返回值表达式必须和return关键字在同一行从而避免插入分号。
3.3.2.if语句
if语句应该使用如下格式:
1.if
(condition)
2.
statements;
3.}
4.
5.if
6.
7.}
else
8.
9.}
10.
11.if
12.
13.}
14.
15.}
16.
17.}
3.3.3.for语句
for语句应该使用如下格式:
1.for
(initialization;
condition;
update)
5.for
(variable
in
object)
7.}
第一种格式应该和数组使用。
第二种格式应该和对象使用。
注意添加到对象的prototype中的成员将被包含在遍历中。
通过使用hasOwnProperty方法来区分对象的成员是明智的:
(object.hasOwnProperty())
3.
5.}
3.3.4.while语句
while语句应该使用如下格式:
1.while
3.3.5.do语句
do语句应该使用如下格式:
1.do
3.}
(condition);
不像其它复合语句,do语句始终使用“;
”(分号)结尾。
3.3.6.switch语句
switch语句应该有如下格式:
1.switch
(expression)
2.case
expression:
4.default:
5.
6.}
每个case和switch对齐,这避免了缩进过度。
每组语句(除了default)应该以break,return或者throw结束。
不要fallthrough。
3.3.7.try语句
try语句应该使用如下格式:
1.try
catch
(variable)
7.try
9.}
11.}
finally
13.}
3.3.8.continue语句
不要使用continue语句。
它会让方法的控制流程模糊。
3.3.9.with语句
不要使用with语句。
3.4.额外建议
3.4.1.{}和[]
使用{}替代newObject()。
使用[]替代newArray()。
当成员名字为连续的整数时使用数组。
当成员名字为任意的字符串或名字时使用对象。
3.4.2.逗号操作符
不要使用逗号操作符,除了for语句的控制部分的严格使用。
(这不适合逗号操作符,它应该用于对象字面量,数组字面量,var语句和参数列表。
)
3.4.3.块作用域
在JavaScript里块没有作用域,只有方法有作用域。
不要使用块,除了复合语句一定需要用到外。
3.4.4.赋值表达式
不要在if和while语句的条件部分做赋值。
不要写不易懂的代码。
3.4.5.===和!
==操作符
始终使用===和!
==操作符会更好。
==和!
=操作符会做类型强制转换。
特别是,不要使用==来和“假”值做比较。
3.4.6.令人混淆的加和减
注意不要在“+”后面跟“+”或“++”。
这种模式令人混淆。
在它们之间插入圆括号来让你的意图更清晰。
1.total=subtotal++myInput.value;
2.
3.//isbetterwrittenas
4.
5.total=subtotal+(+myInput.value);
这样“++”就不会被读错成“++”。
3.4.7.邪恶的eval
eval方法是JavaScript里最滥用的特性。
不要使用它。
eval有别名。
不要使用Function构造函数。
不要传递字符串给setTimeout或者setInterval。
.