ENJOY 前端代码规范-初版

本文档的目标是使 ENJOY 前端小组 JavaScript 代码风格保持一致


  1. 缩进统一使用 4个空格做为一个缩进层级,远离 2个空格 或 tab字符吧基友们
function hello (name) {
       console.log('hi', name)
}
  1. 单双引号统一纯字符串使用单引号,其他双引号
console.log('hello there')
$("<div class='box'>")
  1. 关键字后加空格
    关键字有介么多:if / else / for / while / function / switch / do / try / catch / finally
if (condition) { ... }   // ✓ ok
if(condition) { ... }    // ✗ avoid 
  1. 函数声明、具名函数表达式中,函数名和( 之间加空格
function name (arg) { ... }   // ✓ ok 
function name(arg) { ... }    // ✗ avoid
run(function () { ... })      // ✓ ok 
run(function() { ... })       // ✗ avoid 
  1. 二元运算符两侧必须有一个空格,一元运算符与操作对象之间不能有空格。
// ✓ ok 
var x = 2
var message = 'hello, ' + name + '!'
var a = !arr.length;
a++;
// ✗ avoid 
var x=2
var message = 'hello, '+name+'!'
var a = ! arr.length;
a + + ;
  1. , 后面要加空格,前别加呀
// ✓ ok 
var list = [1, 2, 3, 4]
function greet (name, options) { ... }
// ✗ avoid 
var list = [1,2,3,4]
function greet (name,options) { ... }
  1. 语句换行不加;,晓得不啦
// ✓ ok 
var list = [1, 2, 3, 4]
function greet (name, options) { ... }
//✗ avoid 
var list = [1, 2, 3, 4];
function greet (name, options) { ... };
  1. === 代替 ==
    例外: obj == null ( check null || undefined)
if (name === 'John')   // ✓ ok 
if (name == 'John')    // ✗ avoid 
if (name !== 'John')   // ✓ ok 
if (name != 'John')    // ✗ avoid 
  1. 对于 if...else...,在else前不要添加一个换行
// ✓ ok 
if (condition) {
  // ... 
} else {
  // ... 
}
// ✗ avoid 
if (condition) {
  // ... 
}
else {
  // ... 
}
  1. 在 if...else... 语句中,如果有多行,请使用省略块{...} , 一行的可以不用撒
// ✓ ok 
if (options.quiet !== true) console.log('done')
// ✓ ok 
if (options.quiet !== true) {
  console.log('done')
}
// ✗ avoid 
if (options.quiet !== true)
  console.log('done')
  1. 报错要处理昂
// ✓ ok 
run(function (err) {
  if (err) throw err
  window.alert('done')
})
// ✗ avoid 
run(function (err) {
  window.alert('done')
})
  1. 多余的换行是不允许滴
// ✓ ok 
var value = 'hello world'
console.log(value)
// ✗ avoid 
var value = 'hello world'
换行
换行
换行(打不出来,自行脑补可以伐?
console.log(value)
  1. 对于三目运算如果有多行,?: 请放在语句前面,
// ✓ ok 
var location = env.development ? 'localhost' : 'www.api.com'
// ✓ ok 
var location = env.development
  ? 'localhost'
  : 'www.api.com'
// ✗ avoid 
var location = env.development ?
  'localhost' :
  'www.api.com'
  1. ( , [, ,如果以这三个符号为开头,符号前加上;
// ✓ ok 
;(function () {
      window.alert('ok')
}())
// ✓ ok 
;[1, 2, 3].forEach(bar)
// ✓ ok 
;`hello`.indexOf('o')
// ✗ avoid 
(function () {
      window.alert('ok')
}())
// ✗ avoid 
[1, 2, 3].forEach(bar)
// ✗ avoid 
`hello`.indexOf('o')

当然,我们一般这么做:

var nums = [1, 2, 3]
nums.forEach(bar)

替换

;[1, 2, 3].forEach(bar)

更多待补充...

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,390评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,821评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,632评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,170评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,033评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,098评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,511评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,204评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,479评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,572评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,341评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,213评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,576评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,893评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,171评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,486评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,676评论 2 335

推荐阅读更多精彩内容