You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
// badvarerrorMessage='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.';// badvarerrorMessage='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.';// goodvarerrorMessage='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.';
varitems;varmessages;varlength;vari;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;// badfunctioninbox(messages){items='<ul>';for(i=0;i<length;i++){items+='<li>'+messages[i].message+'</li>';}returnitems+'</ul>';}// goodfunctioninbox(messages){items=[];for(i=0;i<length;i++){// use direct assignment in this case because we're micro-optimizing.items[i]='<li>'+messages[i].message+'</li>';}return'<ul>'+items.join('')+'</ul>';}
// 匿名函数表达式varanonymous=function(){returntrue;};// 命名函数表达式varnamed=functionnamed(){returntrue;};// 立即调用的函数表达式(IIFE)(function(){console.log('Welcome to the Internet. Please follow me.');}());
functionexample(){console.log(anonymous);// => undefinedanonymous();// => TypeError anonymous is not a functionvaranonymous=function(){console.log('anonymous function expression');};}
命名函数表达式会提升变量名,但不会提升函数名或函数体。
functionexample(){console.log(named);// => undefinednamed();// => TypeError named is not a functionsuperPower();// => ReferenceError superPower is not definedvarnamed=functionsuperPower(){console.log('Flying');};}// 当函数名跟变量名一样时,表现也是如此。functionexample(){console.log(named);// => undefinednamed();// => TypeError named is not a functionvarnamed=functionnamed(){console.log('named');}}
// bad// make() returns a new element// based on the passed in tag name//// @param {String} tag// @return {Element} elementfunctionmake(tag){// ...stuff...returnelement;}// good/** * make() returns a new element * based on the passed in tag name * * @param {String} tag * @return {Element} element */functionmake(tag){// ...stuff...returnelement;}
使用 // 作为单行注释。在评论对象上面另起一行使用单行注释。在注释前插入空行。
// badvaractive=true;// is current tab// good// is current tabvaractive=true;// badfunctiongetType(){console.log('fetching type...');// set the default type to 'no type'vartype=this.type||'no type';returntype;}// goodfunctiongetType(){console.log('fetching type...');// set the default type to 'no type'vartype=this.type||'no type';returntype;}
给注释增加 FIXME 或 TODO 的前缀可以帮助其他开发者快速了解这是一个需要复查的问题,或是给需要实现的功能提供一个解决方式。这将有别于常见的注释,因为它们是可操作的。使用 FIXME -- need to figure this out 或者 TODO -- need to implement。
使用 // FIXME: 标注问题。
functionCalculator(){// FIXME: shouldn't use a global heretotal=0;returnthis;}
使用 // TODO: 标注问题的解决方式。
functionCalculator(){// TODO: total should be configurable by an options paramthis.total=0;returnthis;}
Edition 5 clarifies the fact that a trailing comma at the end of an ArrayInitialiser does not add to the length of the array. This is not a semantic change from Edition 3 but some implementations may have previously misinterpreted this.
```javascript
// bad
var hero = {
firstName: 'Kevin',
lastName: 'Flynn',
};
var heroes = [
'Batman',
'Superman',
];
// good
var hero = {
firstName: 'Kevin',
lastName: 'Flynn'
};
var heroes = [
'Batman',
'Superman'
];
```
// good/** * parseInt was the reason my code was slow. * Bitshifting the String to coerce it to a * Number made it a lot faster. */varval=inputValue>>0;
// file contentsclassCheckBox{// ...}module.exports=CheckBox;// in some other file// badvarCheckBox=require('./checkBox');// badvarCheckBox=require('./check_box');// goodvarCheckBox=require('./CheckBox');
当给事件附加数据时(无论是 DOM 事件还是私有事件),传入一个哈希而不是原始值。这样可以让后面的贡献者增加更多数据到事件数据而无需找出并更新事件的每一个处理器。例如,不好的写法:
// bad$(this).trigger('listingUpdated',listing.id);
...
$(this).on('listingUpdated',function(e,listingId){// do something with listingId});
更好的写法:
// good$(this).trigger('listingUpdated',{listingId : listing.id});
...
$(this).on('listingUpdated',function(e,data){// do something with data.listingId});
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Airbnb JavaScript Style Guide() {
用更合理的方式写 JavaScript
目录
类型
原始值: 存取直接作用于它自身。
string
number
boolean
null
undefined
复杂类型: 存取时作用于它自身值的引用。
object
array
function
⬆ 回到顶部
对象
使用直接量创建对象。
不要使用保留字作为键名,它们在 IE8 下不工作。更多信息。
使用同义词替换需要使用的保留字。
⬆ 回到顶部
数组
使用直接量创建数组。
向数组增加元素时使用 Array#push 来替代直接赋值。
当你需要拷贝数组时,使用 Array#slice。jsPerf
使用 Array#slice 将类数组对象转换成数组。
⬆ 回到顶部
字符串
使用单引号
''
包裹字符串。超过 100 个字符的字符串应该使用连接符写成多行。
注:若过度使用,通过连接符连接的长字符串可能会影响性能。jsPerf & 讨论.
程序化生成的字符串使用 Array#join 连接而不是使用连接符。尤其是 IE 下:jsPerf.
⬆ 回到顶部
函数
函数表达式:
永远不要在一个非函数代码块(if、while 等)中声明一个函数,浏览器允许你这么做,但它们的解析表现不一致,正确的做法是:在块外定义一个变量,然后将函数赋值给它。
注: ECMA-262 把
块
定义为一组语句。函数声明不是语句。阅读对 ECMA-262 这个问题的说明。永远不要把参数命名为
arguments
。这将取代函数作用域内的arguments
对象。⬆ 回到顶部
属性
使用
.
来访问对象的属性。当通过变量访问属性时使用中括号
[]
。⬆ 回到顶部
变量
总是使用
var
来声明变量。不这么做将导致产生全局变量。我们要避免污染全局命名空间。使用
var
声明每一个变量。这样做的好处是增加新变量将变的更加容易,而且你永远不用再担心调换错
;
跟,
。最后再声明未赋值的变量。当你需要引用前面的变量赋值时这将变的很有用。
在作用域顶部声明变量。这将帮你避免变量声明提升相关的问题。
⬆ 回到顶部
提升
变量声明会提升至作用域顶部,但赋值不会。
匿名函数表达式会提升它们的变量名,但不会提升函数的赋值。
命名函数表达式会提升变量名,但不会提升函数名或函数体。
函数声明提升它们的名字和函数体。
了解更多信息在 JavaScript Scoping & Hoisting by Ben Cherry.
⬆ 回到顶部
比较运算符 & 等号
优先使用
===
和!==
而不是==
和!=
.条件表达式例如
if
语句通过抽象方法ToBoolean
强制计算它们的表达式并且总是遵守下面的规则:''
被计算为 false,否则为 true使用快捷方式。
了解更多信息在 Truth Equality and JavaScript by Angus Croll.
⬆ 回到顶部
块
使用大括号包裹所有的多行代码块。
如果通过
if
和else
使用多行代码块,把else
放在if
代码块关闭括号的同一行。⬆ 回到顶部
注释
使用
/** ... */
作为多行注释。包含描述、指定所有参数和返回值的类型和值。使用
//
作为单行注释。在评论对象上面另起一行使用单行注释。在注释前插入空行。给注释增加
FIXME
或TODO
的前缀可以帮助其他开发者快速了解这是一个需要复查的问题,或是给需要实现的功能提供一个解决方式。这将有别于常见的注释,因为它们是可操作的。使用FIXME -- need to figure this out
或者TODO -- need to implement
。使用
// FIXME:
标注问题。使用
// TODO:
标注问题的解决方式。⬆ 回到顶部
空白
使用 2 个空格作为缩进。
在大括号前放一个空格。
在控制语句(
if
、while
等)的小括号前放一个空格。在函数调用及声明中,不在函数的参数列表前加空格。使用空格把运算符隔开。
在文件末尾插入一个空行。
在使用长方法链时进行缩进。使用前面的点
.
强调这是方法调用而不是新语句。在块末和新语句前插入空行。
⬆ 回到顶部
逗号
行首逗号: 不需要。
额外的行末逗号:不需要。这样做会在 IE6/7 和 IE9 怪异模式下引起问题。同样,多余的逗号在某些 ES3 的实现里会增加数组的长度。在 ES5 中已经澄清了 (source):
⬆ 回到顶部
分号
使用分号。
了解更多.
⬆ 回到顶部
类型转换
在语句开始时执行类型转换。
字符串:
使用
parseInt
转换数字时总是带上类型转换的基数。如果因为某些原因
parseInt
成为你所做的事的瓶颈而需要使用位操作解决性能问题时,留个注释说清楚原因和你的目的。注: 小心使用位操作运算符。数字会被当成 64 位值,但是位操作运算符总是返回 32 位的整数(source)。位操作处理大于 32 位的整数值时还会导致意料之外的行为。讨论。最大的 32 位整数是 2,147,483,647:
布尔:
⬆ 回到顶部
命名规则
避免单字母命名。命名应具备描述性。
使用驼峰式命名对象、函数和实例。
使用帕斯卡式命名构造函数或类。
不要使用下划线前/后缀。
不要保存
this
的引用。使用 Function#bind。给函数命名。这在做堆栈轨迹时很有帮助。
注: IE8 及以下版本对命名函数表达式的处理有些怪异。了解更多信息到 http://kangax.github.io/nfe/。
如果你的文件导出一个类,你的文件名应该与类名完全相同。
⬆ 回到顶部
存取器
属性的存取函数不是必须的。
如果你需要存取函数时使用
getVal()
和setVal('hello')
。如果属性是布尔值,使用
isVal()
或hasVal()
。创建 get() 和 set() 函数是可以的,但要保持一致。
⬆ 回到顶部
构造函数
给对象原型分配方法,而不是使用一个新对象覆盖原型。覆盖原型将导致继承出现问题:重设原型将覆盖原有原型!
方法可以返回
this
来实现方法链式使用。写一个自定义的
toString()
方法是可以的,但是确保它可以正常工作且不会产生副作用。⬆ 回到顶部
事件
当给事件附加数据时(无论是 DOM 事件还是私有事件),传入一个哈希而不是原始值。这样可以让后面的贡献者增加更多数据到事件数据而无需找出并更新事件的每一个处理器。例如,不好的写法:
更好的写法:
⬆ 回到顶部
模块
模块应该以
!
开始。这样确保了当一个不好的模块忘记包含最后的分号时,在合并代码到生产环境后不会产生错误。详细说明文件应该以驼峰式命名,并放在同名的文件夹里,且与导出的名字一致。
增加一个名为
noConflict()
的方法来设置导出的模块为前一个版本并返回它。永远在模块顶部声明
'use strict';
。⬆ 回到顶部
jQuery
使用
$
作为存储 jQuery 对象的变量名前缀。缓存 jQuery 查询。
对 DOM 查询使用层叠
$('.sidebar ul')
或 父元素 > 子元素$('.sidebar > ul')
。 jsPerf对有作用域的 jQuery 对象查询使用
find
。⬆ 回到顶部
ECMAScript 5 兼容性
⬆ 回到顶部
测试
Yup.
⬆ 回到顶部
性能
⬆ 回到顶部
资源
推荐阅读
工具
其它风格指南
其它风格
进一步阅读
书籍
博客
播客
⬆ 回到顶部
谁在使用
这是一个使用本风格指南的组织列表。给我们发 pull request 或开一个 issue 让我们将你增加到列表上。
翻译
这份风格指南也提供了其它语言的版本:
JavaScript 风格指南说明
与我们讨论 JavaScript
贡献者
许可
(The MIT License)
Copyright (c) 2014 Airbnb
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
⬆ 回到顶部
};
The text was updated successfully, but these errors were encountered: