JavaScript之编码规范推荐

2024-05-06 14:21:56

字体：大中小

来源：转载

供稿：网友

一、命名
1、应给变量和函数取一个含义确切的名称，不要随意命名。
2、非构造函数采用驼峰命名法，尽量采用动宾结构，以与变量名相区别，如getName或IsFull。构造函数（即自定义类型）名称首字母大写，以与非构造函数相区别，如Person。
3、变量采用驼峰命名法。由于JavaScript是一种弱类型语言，因此建议在变量名称前加前缀：整形(i)，浮点数(f)，布尔型(b)，字符串(s)，数组(a)。但不强制这么做，可根据个人爱好选择，选择好后就不要混用加前缀和不加前缀这两种方式了。

二、布局
1、空格。
a）var与变量名之间留一个空格，变量名与等号之间留一个空格，等号与初始值之间留一个空格，初始值与分号之间不留空格。如：var i = 10;
b）使用字面量方式声明引用类型变量时，各个属性与冒号之间不留空格，冒号与初始值之间留一个空格。如：
代码如下:
var Person = {
age: 16,
name: "Sam"
};

c）function与函数名之间留一个空格，函数名与()之间不留空格，()与{之间留一个空格。
d）函数的各个参数之间留一个空格。
e）if、while、for与左括号之间留一个空格，以强调关键字；switch、with与左括号之间不留空格。
f) 二元操作符与左右两个操作数之间留一个空格。当某行代码较长时，也可不留空格。
2、换行。
a）每行语句占用一行，不要多个语句一行。
b）if、while、for等块级作用域后的大括号{不要另起一行，就放在关键字同一行。
3、缩进。
a）缩进使用4个空格，不要使用tab。
b）作用域不一样时就应当进行缩进，以显示出其层次关系。

三、注释
1、合理添加注释。注释不能完全没有，也不是越多越好。给重要的方法、变量和算法（或其他需要注意的问题）添加注释即可。
2、修改源代码时，需要同步修改注释，保持两者的一致。
3、不要在代码中使用html方式的注释。

四、规范
1、申明变量时必须加var关键字。虽然JavaScript允许不加var关键字，此时成为全局变量，但这是导致问题的一个来源。
2、申明变量时必须同时进行初始化，之后最好不要再改变变量的数据类型了。
3、语句末尾可以加分号的，必须加分号。
4、if、while、for等仅有一条语句时，也需要放在大括号内。
5、不要随意使用全局变量，如果不得不使用，最好只用一个全局变量。
6、JavaScript与html、css之间应保持松散耦合。html是数据层，css是表现层，JavaScript是行为层，三者应避免紧密的耦合，否则会导致后期难以维护。html中不要有具体的JavaScript代码，全部采用包含外部文件的方式；JavaScript中也尽量不要使用innerHTML等插入大量html元素，应考虑将元素放在html中，只不过初始隐藏即可；JavaScript中不要直接修改css中的具体属性，而应通过className来间接修改。

上一篇：JS中处理与当前时间间隔的函数代码

下一篇：inputSuggest文本框输入时提示、自动完成效果(邮箱输入自动补全插