前端开发命名规范

一,通用命名规则(必须)

 1,所有变量必须是有意义的英文，严厉禁止拼音,做到见名知义,禁止不明声明,如var a,var abc1,var abc2；
 2,变量命名采用小驼峰法(第一个单词首字母小写，其余单词首字母大写),例如goodName；
 3,变量允许使用公认英文缩写，例如nav；
 4,常量必须所有单词大写，并且每个单词之间加下划线例如STUDENT_SCORE；
 5,类命名必须是大驼峰法(所有单词第一个字母均大写),例如StudentScore；
 6,私有类的变量属性成员， 建议使用混合式命名，并前面下下划线；
 7,“on”只能用作事件的命名；
 8,所有全局变量必须初始化,不得声明例如 var i,j；
 9,保留字以及特有的dom属性不能作为变量名,例如class，ul，li

QQ20171114-0.jpg

二、变量命名规范(参考)

*类型前缀 + 有意义的单词
1,字符串：sXXX，如：sName，sHtml；
2,数字：nXXX，如：nPage，nTotal；
3,逻辑：bXXX，如：bChecked，bHasLogin；
4,数组：aXXX，如：aList，aGroup；
5,正则：rXXX，如：rDomain，rEmail；
6,函数：fXXX，如：fGetList；
7,DOM节点：dXX，如：dDiv，dSpan；
8,其他类型：oXXX，如：oButton，oDate；
9,特殊简写：小范围作用域临时变量，如函数内部的局部变量或参数：o(Object)、e(Element)、evt(event)、err(errot)等；
10,循环变量：i、j、k以此类推；

三、书写规范(必须)

1,必须使用 Tab 键进行代码缩进；
2,所有语句结束后，必须使用 ; 号结束,每行必须已;结尾；
3,操作符必须使用空格隔开

普通代码段应该如下:

while(!isDone) 
{
    doSomething();
    isDone = moreToDo();
}
或者
while(!isDone) {
    doSomething();
    isDone = moreToDo();
}

变量定义方法如下：

var a = null;
var b = 1;
var c = 0;
var d = [];

函数定义方法如下：

var funcA = function() {
    var a = 0;
    ...
}
或者
var funcA = ()=>{};

if 语句应该像这样：

if(someCondition) {
    statements;
} else if(someOtherCondition) {
    statements;
} else {
    statements;
}
或者
if(someCondition) return;
if(elseCondition) {};

for 语句应该像这样：

for(var i in data)
{
}
或者
for(initialization; condition; update) {
    statements;
}

do … while 语句应该像这样：

do {
    statements;
} while(condition);

switch 语句应该像这样：

switch(condition) {
    case "A":statements; break;
    case "B":
        statements;
        break;
    default:
        statements;
        break;
}

try … catch 语句应该像这样：

try {
    statements;
} catch(ex) {
    statements;
} finally {
    statements;
}

对象定义规范:
在Javascript中，所有类型都是对象，包括string类型。函数的定义，统一使用以下方式：

var a = function() {...};
var b = ()=>{};

最后要加上 “;”号，禁止再使用以下方式：

function a() {}

最后编辑于：2017.11.28 11:45:18