JS编码规范.docx

JavaScript编码规范
说明
本规范适用于汉捷机械部件（常州）有限公司信息技术部，为公司的系统开发提供标准及约定，有助于软件开发人员快速掌握JS的编码规则，能够快速的融入到团队开发中，使用团队开发的效率大大提高。
命名规范
基er isNan
10. 处理错误的变量，必须在后面跟着 “Error”
11. 尽量做有意义的代码折行，不要让一行代码过长。 (HTML 字符串除外)
12. 逗号（ , ） 建议使用空格隔开。
13. 操作符建议使用空格隔开（包括三元操作符）。var i = k < 0 ? 1 : 0;
语法规范
变量
1. 保留字以及特有的 dom 属性不能作为变量名
2. 公有变量必须清楚的表达其自身的属性，避免字义含糊不清
3. 不允许频繁使用 previousSibling 和 nextSibling
4. 不允许使用多次 parentNode 对变更频繁的页面做精确的 dom 定位
5. 重复变量建议使用 "i", "j", "k" （依次类推）等名称的变量(全世界公认)
6. 所有全局变量必须初始化
函数
1. 初始化用的函数必须使用“init”开头，如果一个页面只有初始化可以单独使用 init()
2. 基类可以在明确描述其属性的前提下，缩减其命名
3. 函数调用和方法避免使用空白
参数
1. 多个可选参数必须以 Hash 表的方式传入
function foo(a,b,c,opt); //其中 a,b,c 都是 foo 的必选参数，opt 是可选参数
2. 不允许必选参数之间夹带可选参数
语法布局参考
1. 普通代码段应该看起来如下：
while(!isDone){
doSomething();
isDone = moreToDo();
}
2. if 语句应该看起来像这样：
if(someCondition){
statements;
}elseif(someOtherCondition){
statements;
}else{
statements;
}
3. for 语句应该看起来像这样：
for(initialization; condition; update){
statements;
}
4. while 语句应该看起来像这样：
while(!isDone){
doSomething();
isDone = moreToDo();
}
5. do ... while 语句应该看起来像这样：
do{
statements;
}while(condition);
6. switch 语句应该看起来像这样：
switch(condition){
case ABC:
statements;
// fallthrough
case DEF:
statements;
break;
default:
statements;
break;
}
7. try ... catch 语句应该看起来像这样：
try{
statements;
}catch(ex){
statements;
}finally{
statements;
}
8. 单行的 if – else，