javascript编程规范

搜索

您当前位置：首页 > 文章中心 > 网页编程 > Javascript

【Javascript】

下载

新闻

文章

javascript编程规范

一、编程风格

1. 行末逗号对行首逗号

//Good: 行末引号
var foo = 1,
    bar = 2,
    baz = 3;

var obj = {
    foo: 1,
    bar: 2,
    baz: 3
};

//Bad: 行首引号
var foo = 1
  , bar = 2
  , baz = 3;

var obj = {
    foo: 1
  , bar: 2
  , baz: 3
};

2. 缩进使用空格和Tab

请将IDE或文本编辑器的缩进设置为4个空格

使用空格缩进可以保证不同的开发者、不同的编辑器设置下看到的结果是一样的。

3. 函数后是否添加空格

//Good: 无空格

function foo() {
  return "bar";
}

//Bad: 有空格
function foo () {
  return "bar";
}

4. 参数与括号间是否有空格

//Good: 无空格

function fn(arg1, arg2) {
  //  ...
}
if (true) {
  //  ...
}

//Bad: 有空格
function fn( arg1, arg2 ) {
   // ...
}
if ( true ) {
   // ...
}

5. 对象字面量中冒号周围是否有空格

//Good: 冒号后有空格

{
  foo: 1,
  bar: 2,
  baz: 3
}

//Bad: 冒号后无空格
{
  foo:1,
  bar:2,
  baz:3
}
//Bad: 冒号前后均有空格
{
  foo : 1,
  bar : 2,
  baz : 3
}

6. 条件语句关键词与条件之间是否有空格

// Good: 有空格
if (true) {
  //...
}
while (true) {
  //...
}
switch (v) {
  //...
}

//Bad: 无空格
if(true) {
  //...
}
while(true) {
  //...
}
switch(v) {
  //...
}

7. 单引号、双引号

//Good: 单引号
var str = 'test';
var el = $('.el');
if (a === 'b'){
}


//Bad: 双引号
var str = "test";
var el = $(".el");
if (a === "b"){
}

小结

行末逗号
空格缩进
函数名称后无空格
函数参数与括号间无空格
对象字面量的冒号后加空格，冒号前不加
条件语句关键字后加空格

二、命名规范

1. 基本原则

尽量避免潜在冲突，见名知意；
如非无法避免，不能随意定义全局的变量；
请将闭包内用到的外部变量挂载在全局的对象下，即命名空间下。

2. 命名通则

常量全部大写，单词以下划线分隔

//Good
var STATIC_PATH = 'http://pcs.shenba.com/_src';
var SB_DOMAIN = 'www.shenba.com';

//Bad
var staticPath = 'http://pcs.shenba.com/_src';
var sb_domain = 'www.shenba.com';

####类名首字母大写

//Good
var ClassA = function(){};
var ClassB = function(){};
//Bad
var classA = function(){}
var classB = function(){}

普通变量、方法和函数，采用驮峰式写法，首字母小写

//Good
var userName = $('#user_name');
var msgCode = $('#msg_code');

//Bad
var username = $('#user_name');
var msgcode = $('#msg_code');

//Bad
var user_name = $('#user_name');
var msg_code = $('#msg_code');

局部变量、私有变量、私有属性和私有方法，名字以下划线开头

var ClassFrom = function(){
  var _from = $('.reg-from');
  this.getUserName = function(){
    var _userName = _from.find('#user_name');
    return _userName;
  };
  this.getCode = function(){
    var _code = _from.find('#check_code');
    return _code;
  };
  //more code...
};
var newFrom = new ClassFrom();
var code = newFrom.getCode();

条件表达式、正则表式式，如果很复杂，给其命名

//Good
_stream = function(files, cb, cb2) {
  var _amdReg = /;?\s*define\s*\(([^(]*),?\s*?function\s*\([^\)]*\)/;
  var _depArrReg = /^[^\[]*(\[[^\]\[]*\]).*$/;
  //code...
  _source = _source.replace(_amdReg, function(str, map) {
    _depStr = map.replace(_depArrReg, "$1")
    //code...
  )}
};

//Bad
_stream = function(files, cb, cb2) {
  //code...
  _source = _source.replace(/;?\s*define\s*\(([^(]*),?\s*?function\s*\([^\)]*\)/, function(str, map) {
    _depStr = map.replace(/^[^\[]*(\[[^\]\[]*\]).*$/, "$1")
    //code...
  )}
};