• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    迪恩网络公众号
登陆 注册
描述文字

adamlu/javascript-style-guide: JavaScript规范

原作者: [db:作者] 来自: 网络 收藏 邀请

开源软件名称：

adamlu/javascript-style-guide

开源软件地址：

https://github.com/adamlu/javascript-style-guide

开源编程语言：


开源软件介绍：

原文: https://github.com/airbnb/javascript

注：本人根据自己的开发习惯删除和修改了部分规范

JavaScript规范

内容列表

  1. 类型
  2. 对象
  3. 数组
  4. 字符串
  5. 函数
  6. 属性
  7. 变量
  8. 条件表达式和等号
  9. 块
  10. 注释
  11. 空白
  12. 逗号
  13. 分号
  14. 类型转换
  15. 命名约定
  16. 存取器
  17. 构造器
  18. 事件
  19. 模块
  20. jQuery
  21. ES5 兼容性
  22. 性能
  23. 资源
  24. 哪些人在使用
  25. 翻译
  26. JavaScript风格指南
  27. 贡献者
  28. 许可

类型

  • 原始值: 相当于传值

    • string
    • number
    • boolean
    • null
    • undefined
    var foo = 1,
    bar = foo;

bar = 9;

console.log(foo, bar); // => 1, 9

  • 复杂类型: 相当于传引用

    • object
    • array
    • function
    var foo = [1, 2],
    bar = foo;

bar[0] = 9;

console.log(foo[0], bar[0]); // => 9, 9

    [⬆]

对象

  • 使用字面值创建对象

    // bad
var item = new Object();

// good
var item = {};

  • 不要使用保留字 reserved words 作为键

    // bad
var superman = {
  class: 'superhero',
  default: { clark: 'kent' },
  private: true
};

// good
var superman = {
  klass: 'superhero',
  defaults: { clark: 'kent' },
  hidden: true
};

    [⬆]

数组

  • 使用字面值创建数组

    // bad
var items = new Array();

// good
var items = [];

  • 如果你不知道数组的长度，使用push

    var someStack = [];


// bad
someStack[someStack.length] = 'abracadabra';

// good
someStack.push('abracadabra');

  • 当你需要拷贝数组时使用slice. jsPerf

    var len = items.length,
    itemsCopy = [],
    i;

// bad
for (i = 0; i < len; i++) {
  itemsCopy[i] = items[i];
}

// good
itemsCopy = items.slice();

  • 使用slice将类数组的对象转成数组.

    function trigger() {
  var args = Array.prototype.slice.call(arguments);
  ...
}

    [⬆]

字符串

  • 对字符串使用单引号 ''

    // bad
var name = "Bob Parr";

// good
var name = 'Bob Parr';

// bad
var fullName = "Bob " + this.lastName;

// good
var fullName = 'Bob ' + this.lastName;

  • 超过80个字符的字符串应该使用字符串连接换行

  • 注: 如果过度使用，长字符串连接可能会对性能有影响. jsPerf & Discussion

    // bad
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.';

// bad
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.';


// good
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.';

  • 编程时使用join而不是字符串连接来构建字符串，特别是IE: jsPerf.

    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;

// bad
function inbox(messages) {
  items = '<ul>';

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

  return items + '</ul>';
}

// good
function inbox(messages) {
  items = [];

  for (i = 0; i < length; i++) {
    items[i] = messages[i].message;
  }

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

    [⬆]

函数

  • 函数表达式:

    // 匿名函数表达式
var anonymous = function() {
  return true;
};

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

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

  • 绝对不要在一个非函数块里声明一个函数，把那个函数赋给一个变量。浏览器允许你这么做，但是它们解析不同。

  • 注: ECMA-262定义把块定义为一组语句，函数声明不是一个语句。阅读ECMA-262对这个问题的说明.

    // bad
if (currentUser) {
  function test() {
    console.log('Nope.');
  }
}

// good
if (currentUser) {
  var test = function test() {
    console.log('Yup.');
  };
}

  • 绝对不要把参数命名为 arguments, 这将会逾越函数作用域内传过来的 arguments 对象.

    // bad
function nope(name, options, arguments) {
  // ...stuff...
}

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

    [⬆]

属性

  • 当使用变量访问属性时使用中括号.

    var luke = {
  jedi: true,
  age: 28
};

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

var isJedi = getProp('jedi');

    [⬆]

变量

  • 总是使用 var 来声明变量，如果不这么做将导致产生全局变量，我们要避免污染全局命名空间。

    // bad
superPower = new SuperPower();

// good
var superPower = new SuperPower();

  • 使用一个 var 以及新行声明多个变量，缩进4个空格。

    // bad
var items = getItems();
var goSportsTeam = true;
var dragonball = 'z';

// good
var items = getItems(),
    goSportsTeam = true,
    dragonball = 'z';

  • 最后再声明未赋值的变量，当你想引用之前已赋值变量的时候很有用。

    // bad
var i, len, dragonball,
    items = getItems(),
    goSportsTeam = true;

// bad
var i, items = getItems(),
    dragonball,
    goSportsTeam = true,
    len;

// good
var items = getItems(),
    goSportsTeam = true,
    dragonball,
    length,
    i;

  • 在作用域顶部声明变量，避免变量声明和赋值引起的相关问题。

    // bad
function() {
  test();
  console.log('doing stuff..');

  //..other stuff..

  var name = getName();

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

  return name;
}

// good
function() {
  var name = getName();

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

  //..other stuff..

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

  return name;
}

// bad
function() {
  var name = getName();

  if (!arguments.length) {
    return false;
  }

  return true;
}

// good
function() {
  if (!arguments.length) {
    return false;
  }

  var name = getName();

  return true;
}

    [⬆]

条件表达式和等号

  • 适当使用 === 和 !== 以及 == 和 !=.

  • 条件表达式的强制类型转换遵循以下规则：

    • 对象 被计算为 true
    • Undefined 被计算为 false
    • Null 被计算为 false
    • 布尔值 被计算为 布尔的值
    • 数字 如果是 +0, -0, or NaN 被计算为 false , 否则为 true
    • 字符串 如果是空字符串 '' 则被计算为 false, 否则为 true
    if ([0]) {
  // true
  // An array is an object, objects evaluate to true
}

  • 使用快捷方式.

    // bad
if (name !== '') {
  // ...stuff...
}

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

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

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

  • 阅读 Truth Equality and JavaScript 了解更多

    [⬆]

块

  • 给所有多行的块使用大括号

    // bad
if (test)
  return false;

// good
if (test) return false;

// good
if (test) {
  return false;
}

// bad
function() { return false; }

// good
function() {
  return false;
}

    [⬆]

注释

  • 使用 /** ... */ 进行多行注释，包括描述，指定类型以及参数值和返回值

    // bad
// make() returns a new element
// based on the passed in tag name
//
// @param <String> tag
// @return <Element> element
function make(tag) {

  // ...stuff...

  return element;
}

// good
/**
 * make() returns a new element
 * based on the passed in tag name
 *
 * @param <String> tag
 * @return <Element> element
 */
function make(tag) {

  // ...stuff...

  return element;
}

  • 使用 // 进行单行注释，在评论对象的上面进行单行注释，注释前放一个空行.

    // bad
var active = true;  // is current tab

// good
// is current tab
var active = true;

// bad
function getType() {
  console.log('fetching type...');
  // set the default type to 'no type'
  var type = this._type || 'no type';

  return type;
}

// good
function getType() {
  console.log('fetching type...');

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

  return type;
}

  • 如果你有一个问题需要重新来看一下或如果你建议一个需要被实现的解决方法的话需要在你的注释前面加上 FIXME 或 TODO 帮助其他人迅速理解

    function Calculator() {

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

  return this;
}
    function Calculator() {

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

  return this;
}

鲜花
握手
雷人
路过
鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
More+
上一篇：
harrywfl/JavaGuide: 【Java学习+面试指南】 一份涵盖大部分Java程序员所需要掌握的核 ...发布时间：2022-06-23
下一篇：
binarywang/java-testdata-generator: 使用Java实现的各种测试数据的随机生成工具，包 ...发布时间：2022-06-23
热门推荐
More+
热门话题
More+
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服（服务时间 9:00～18:00）

在线QQ客服
地址：深圳市南山区西丽大学城创智工业园
电邮：jeky_zhao#qq.com
移动电话：139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap