整理了一份 Javascript 代码书写规范

2023-10-07 16:50:29 浏览数 (1)

基于对参考文档进行整理，方便读者参照，有建议之处，欢迎留言。

无论有多少人在维护，所有在代码仓库中的代码理应看起来像同一个人写的。

变量

(1)申明变量时，必须使用 var 。如果不这么做，所申明的变量将会是一个全局变量，我们要劲量避免申明全局变量。

注:使用一个 var 打头申明一组变量,是最有效率的。

代码语言：javascript复制
var items = getItems(),
    goSportsTeam = true,
    dragonball = 'z';
（2）请在作用域的顶部申明变量，这样做主要避免变量申明和赋值提升相关的问题。
代码语言：javascript复制
function() {
  var name = getName();

  test();
  console.log('doing stuff..');

  //..other stuff..

  if (name === 'test') {
    return false;
  }

  return name;
}

字符串

(1)使用单引号定义字符串
代码语言：javascript复制
var name = 'Bob Parr';

var fullName = 'Bob '   this.lastName;
字符串长度超过80个字符是，应该分成多行，通过字符串连接符( )进行连接。

注：如果过度使用连接符，长字符串拼接会有性能问题。

代码语言：javascript复制
var errorMessage = 'This is a super long error that was thrown because '  
  'of Batman. When you stop to think about how Batman had anything to do '  
  'with this, you would get nowhere fast.';
(3)使用数组方法join替代连接符
代码语言：javascript复制
var items,
 	messages,
 	length,
 	i;

messages = [{
  state: 'success',
  message: 'This one worked.'
}, {
  state: 'success',
  message: 'This one worked as well.'
}, {
  state: 'error',
  message: 'This one did not work.'
}];

length = messages.length;


function inbox(messages) {
  items = [];

  for (i = 0; i < length; i  ) {
    items[i] = '<li>'   messages[i].message   '</li>';
  }

  return '<ul>'   items.join('')   '</ul>';
}

数组

(1)创建数组
代码语言：javascript复制
var a = [x1, x2, x3];
var a2 = [x1, x2];
var a3 = [x1];
var a4 = [];
(2)数组中添加元素-push()
代码语言：javascript复制
var someStack = [];

someStack.push('abracadabra');
(3)拷贝数组-slice()
代码语言：javascript复制
var len = items.length;
var itemsCopy = [];
var i;

itemsCopy = items.slice();

函数

(1)定义函数
代码语言：javascript复制
// 匿名 function 表达式
var anonymous = function() {
  return true;
};

// 命名 function 表达式
var named = function named() {
  return true;
};

// 立即执行 function 表达式 
(function() {
  console.log('Welcome to the Internet. Please follow me.');
})();
(2)使用函数

注:绝对不要在“非功能”块中申明方法（如，if、while等），而是通过将方法赋值给一个变量实现。

代码语言：javascript复制
var test;
if (currentUser) {
  test = function test() {
    console.log('Yup.');
  };
}
(3)参数arguments

绝对不用使用arguments作为方法的参数名。它会高优先级的覆盖掉每个方法中默认都有的arguments对象。

代码语言：javascript复制
// bad
function nope(name, options, arguments) {
  // ...stuff...
}

// good
function yup(name, options, args) {
  // ...stuff...
}
(4)调用

使用锯齿状缩进将函数连分割成多行，并以 . 开头，以强调只是针对一个函数的调用，而不是一个新的语句。

代码语言：javascript复制
('#items')
  .find('.selected')
    .highlight()
    .end()
  .find('.open')
    .updateCount();
代码语言：javascript复制
var leds = stage.selectAll('.led')
    .data(data)
  .enter().append('svg:svg')
    .classed('led', true)
    .attr('width', (radius   margin) * 2)
  .append('svg:g')
    .attr('transform', 'translate('   (radius   margin)   ','   (radius   margin)   ')')
    .call(tron.led);

对象

(1)创建对象
代码语言：javascript复制
var item = {};
var item2 = {
  a: 0,
  b: 1,
  c: 2,
  'strange key': 3
};

注:不要使用保留关键字作为key，IE8中会报错。

代码语言：javascript复制
// bad
var superman = {
  default: { clark: 'kent' },
  private: true
};

// good
var superman = {
  defaults: { clark: 'kent' },
  hidden: true
};
(2) 键值命名

使用可辨识的同义词替换保留关键词

代码语言：javascript复制
// bad
var superman = {
  class: 'alien'
};

// good
var superman = {
  type: 'alien'
};

对象属性

###(1)访问对象属性

代码语言：javascript复制
var luke = {
  jedi: true,
  age: 28
};
var isJedi = luke.jedi;//使用 . 访问对象的属性

当属性名放在一个变量中时，使用下标 [] 的形式访问属性

代码语言：javascript复制
var luke = {
  jedi: true,
  age: 28
};

function getProp(prop) {
  return luke[prop];
}

var isJedi = getProp('jedi');

比较操作符

(1) 优先使用 === 和 !== 替换 == 和 !=

if条件判断语句,会遵循下面简单的规则，将表达式转换为布尔型的值:

  • Objects 等价于 true
  • Undefined 等价于 false
  • Null 等价于 false
  • Booleans 等价于 对应的布尔值
  • Numbers 如果是 0 或者 NaN 等价于 false，其他的等价于 true
  • Strings 除了空字符串 ‘’ 等价于 false，其他的等价于 true
代码语言：javascript复制
if ([0]) {
  // true
  // Objects 等价于 true,数组也是对象
}

(2)短判断

代码语言：javascript复制
// bad
if (name !== '') {
  // ...stuff...
}

// good
if (name) {
  // ...stuff...
}

// bad
if (collection.length > 0) {
  // ...stuff...
}

// good
if (collection.length) {
  // ...stuff...
}

代码块

(1)单行代码块
代码语言：javascript复制
if (test) return false;
(2)if-else

如果使用多行的if、else语句，else 应该跟在前一个 if 代码块的 } 后面。

代码语言：javascript复制
if (test) {
  thing1();
  thing2();
} else {
  thing3();
}
(3)for循环
代码语言：javascript复制
var i,
    length = 100;

for ( i = 0; i < length; i   ) {
  // 语句
}
代码语言：javascript复制
var prop;
for ( prop in object ) {
  // 语句
}
(4)代码块之间

在每个代码块后面保留一个空行，然后再写后面的语句。

代码语言：javascript复制
var obj = {
  foo: function() {
  },

  bar: function() {
  }
};

return obj;

注释

(1)多行注释

/** … */注释内容包括描述，所有参数、返回值的具体类型和值.

sublime 下载 DocBlockr插件，帮助你创造你的代码注释

代码语言：javascript复制
/**
 * make() returns a new element
 * based on the passed in tag name
 *
 * @param {String} tag
 * @return {Element} element
 */
 function make(tag) {

  // ...stuff...

  return element;
}
(2)单行注释

使用 javascript// 进行单行注释。注释时，在需要注释的语句上面新起一行，并在注释的上面保留一行空行。

代码语言：javascript复制
// good
// is current tab
var active = true;
代码语言：javascript复制
function getType() {
  console.log('fetching type...');

  // set the default type to 'no type'
  var type = this._type || 'no type';

  return type;
}
(3)FIXME和TODO前缀

使用前缀 FIXME 和 TODO 标注注释，方便开发人员快速理解需要解决的问题，或着提出解决的建议。

代码语言：javascript复制
// 使用 FIXME 标注一个问题
function Calculator() {

  // FIXME: shouldn't use a global here
  total = 0;

  return this;
}
代码语言：javascript复制
// 使用 TODO 标注问题的解决方案
function Calculator() {

  // TODO: total should be configurable by an options param
  this.total = 0;

  return this;
}

空格与Tab

(1)永远都不要混用空格和Tab;

(2)编辑中设置两个空格代替Tab;

(3)在 { 前放着一个空格;

(4)在 if 、while等语句的 ( 前放置一个空格。

(5)用空格将操作符隔开

代码语言：javascript复制
var x = y   5;

分号

需要在每个语句结束的时候都添加分号。

代码语言：javascript复制
(function() {
  var name = 'Skywalker';
  return name;
})();

类型转换

(1)parseInt

使用parseInt转换成数字是需要标注出进制;

代码语言：javascript复制
var inputValue = '4';

var val = Number(inputValue);

//or

var val = parseInt(inputValue, 10);
(2)布尔
代码语言：javascript复制
var age = 0;

var hasAge = Boolean(age);

//or

var hasAge = !!age;

命名规范

(1) 避免使用单个字母进行命名。尽量描述清楚你的命名;

(2)使用全字母大写，下划线分隔的方式命名不变量。不要使用 const 关键词命名常量，ie不支持。

代码语言：javascript复制
var MD5_key = 'ya23adfuodf4sd';

(3)使用驼峰命名法（camelCase），命名你的对象、方法和实例

代码语言：javascript复制
var thisIsMyObject = {};
function thisIsMyFunction() {}

(4) 正则表达式变量使用 r 作为前缀

代码语言：javascript复制
rNumber = /(d) /;

(5)使用帕斯卡命名法（PascalCase），命名你的构造函数或类

代码语言：javascript复制
function User(options) {
  this.name = options.name;
}

var good = new User({
  name: 'yup'
});

(6)用下划线打头命名私有属性

代码语言：javascript复制
this._firstName = 'Panda';

(7)用 _this 保存 this 的引用

代码语言：javascript复制
function() {
  var _this = this;
  return function() {
    console.log(_this);
  };
}

jquery

(1)命名jQuery对象的变量时，用 $ 作为前缀
代码语言：javascript复制
var $sidebar = $('.sidebar');

闭包

闭包会在它封闭的作用域中保存变量引用。其结果是，附带着会创建DOM对象的循环引用，从而产生内存泄露。 例如下面的代码：

代码语言：javascript复制
// bad
function foo(element, a, b) {
  element.onclick = function() { /* uses a and b */ };
}

在这个匿名方法中，闭包保存了element、a和b的引用，即使它不会用到element。我们构建了一个闭环，导致不会被垃圾清理回收。 在这种情况下，可以做如下重构：

代码语言：javascript复制
// good
function foo(element, a, b) {
  element.onclick = bar(a, b);
}

function bar(a, b) {
  return function() { /* uses a and b */ };
}

delete

尽量避免使用delete删除键

代码语言：javascript复制
// bad
Foo.prototype.dispose = function() {
  delete this.property_;
};

// good
Foo.prototype.dispose = function() {
  this.property_ = null;
};

使用JSON.parse替代eval

代码语言：javascript复制
{
  "name": "Alice",
  "id": 31502,
  "email": "looking_glass@example.com"
}

var userInfo = JSON.parse(feed);

var email = userInfo['email'];

不要使用with(){}

使用with语句速度要比不使用with语句的等价代码的速度慢得多,90%(或者更高比例)的with应用场景都可以用其他更好的方式代替。

参考

  • https://github.com/rwaldron/idiomatic.js/tree/master/translations/zh_CN (idiomatic代码风格)
  • https://github.com/hbxeagle/JavaScriptStyleGuide(代码规范指导)
  • https://github.com/adamlu/javascript-style-guide
  • http://javascript.ruanyifeng.com/grammar/style.html(阮一峰-代码风格)
javascript var 变量 对象 字符串

0 人点赞