Google為了那些還不熟悉代碼規(guī)范的人發(fā)布了一個(gè)JS代碼規(guī)范。其中列出了編寫簡(jiǎn)潔易懂的代碼所應(yīng)該做的***實(shí)踐。

代碼規(guī)范并不是一種編寫正確JavaScript代碼的規(guī)則，而是為了保持源代碼編寫模式一致的一種選擇。對(duì)于JavaScript語(yǔ)言尤其如此，因?yàn)樗`活并且約束較少，允許開(kāi)發(fā)者使用許多不同的編碼樣式。

Google和Airbnb各自占據(jù)著當(dāng)前***的編碼規(guī)范的半壁江山。如果你會(huì)在編寫JS代碼上投入很長(zhǎng)時(shí)間的話，我強(qiáng)烈推薦你通讀一遍這兩家公司的編碼規(guī)范。

接下來(lái)要寫的是我個(gè)人認(rèn)為在Google的代碼規(guī)范中，與日常開(kāi)發(fā)密切相關(guān)的十三條規(guī)則。

它們處理的問(wèn)題都非常具有爭(zhēng)議性，包括tab與空格、是否強(qiáng)制使用分號(hào)等等。還有一些令我感到驚訝的規(guī)則，往往***都改變了我編寫JS代碼的習(xí)慣。

對(duì)于每一條規(guī)則，我都會(huì)先給出規(guī)范的摘要，然后引用規(guī)范中的詳細(xì)說(shuō)明。我還會(huì)舉一些適當(dāng)?shù)姆蠢撟C遵守這些規(guī)則的重要性。

使用空格代替tab

除了每一行的終止符序列，ASCII水平空格符（0x20）是唯一一個(gè)可以出現(xiàn)在源文件中任意位置的空格字符。這也意味著，tab字符不應(yīng)該被使用，以及被用來(lái)控制縮進(jìn)。

規(guī)范隨后指出應(yīng)該使用2個(gè)，而不是4個(gè)空格帶實(shí)現(xiàn)縮進(jìn)。 

// bad  
function foo() {  
∙∙∙∙let name;  
}  
// bad  
function bar() {  
∙let name;  
}  
// good  
function baz() {  
∙∙let name;  
} 

不能省略分號(hào)

每個(gè)語(yǔ)句必須以分號(hào)結(jié)尾。不允許依賴于JS自動(dòng)添加分號(hào)的功能。

盡管我不明白為什么會(huì)有人反對(duì)這個(gè)規(guī)則，但目前分號(hào)的使用問(wèn)題顯然已經(jīng)像“空格 vs tab”這個(gè)問(wèn)題一樣產(chǎn)生了巨大的爭(zhēng)議。而Google對(duì)此表示分號(hào)是必須的，是不可省略的。 

// bad  
let luke = {}  
let leia = {}  
[luke, leia].forEach(jedi => jedi.father = 'vader')  
// good  
let luke = {};  
let leia = {};  
[luke, leia].forEach((jedi) => {  
  jedi.father = 'vader';  
}); 

暫時(shí)不要使用ES6 module

由于ES6模塊的語(yǔ)義尚不完全確定，所以暫時(shí)不要使用，比如export和import關(guān)鍵字。一旦它們的相關(guān)規(guī)范制定完成，那么請(qǐng)忽略這一條規(guī)則。 

// 暫時(shí)不要編寫下面的代碼： 
//------ lib.js ------  
export function square(x) {  
    return x * x;  
}  
export function diag(x, y) {  
    return sqrt(square(x) + square(y));  
}  
//------ main.js ------  
import { square, diag } from 'lib'; 

譯者注：感覺(jué)遵守這條規(guī)范不大現(xiàn)實(shí)，畢竟現(xiàn)在已經(jīng)有babel了。而且使用React時(shí)，***實(shí)踐就是使用ES6模塊吧。

不推薦代碼水平對(duì)齊

Google的代碼規(guī)范允許但不推薦對(duì)代碼進(jìn)行水平對(duì)齊。即使之前的代碼中做了水平對(duì)齊的處理，以后也應(yīng)該避免這種行為。

對(duì)代碼進(jìn)行水平對(duì)齊會(huì)在代碼中添加若干多余的空格，這讓相鄰兩行的字符看上去處于一條垂直線上。 

// bad  
{  
  tiny:   42,    
  longer: 435,   
};  
// good  
{  
  tiny: 42,   
  longer: 435,  
}; 

杜絕var

使用const或let來(lái)聲明所有局部變量。如果變量不需要被重新賦值，默認(rèn)應(yīng)該使用const。應(yīng)該拒絕使用關(guān)鍵字var。

我不知道是因?yàn)闆](méi)有人能說(shuō)服他們，還是說(shuō)因?yàn)榕f習(xí)難改。目前我仍能看到許多人在StackOverFlow或其他地方使用var聲明變量。 

// bad  
var example = 42;  
// good  
const example = 42; 

優(yōu)先使用箭頭函數(shù)

箭頭函數(shù)提供了一種簡(jiǎn)潔的語(yǔ)法，并且避免了一些關(guān)于this指向的問(wèn)題。相比較與function關(guān)鍵字，開(kāi)發(fā)者應(yīng)該優(yōu)先使用箭頭函數(shù)來(lái)聲明函數(shù)，尤其是聲明嵌套函數(shù)。

坦白說(shuō)，我曾以為箭頭函數(shù)的作用只在于簡(jiǎn)潔美觀。但現(xiàn)在我發(fā)現(xiàn)原來(lái)它們還有更重要的作用。 

// bad  
[1, 2, 3].map(function (x) {  
  const y = x + 1;  
  return x * y;  
});  
// good  
[1, 2, 3].map((x) => {  
  const y = x + 1;  
  return x * y;  
}); 

使用模板字符串取代連接字符串

在處理多行字符串時(shí)，模板字符串比復(fù)雜的拼接字符串要表現(xiàn)的更出色。 

// bad  
function sayHi(name) {  
  return 'How are you, ' + name + '?';  
}  
// bad  
function sayHi(name) {  
  return ['How are you, ', name, '?'].join();  
}  
// bad  
function sayHi(name) {  
  return `How are you, ${ name }?`;  
}  
// good  
function sayHi(name) {  
  return `How are you, ${name}?`;  
} 

不要使用續(xù)行符分割長(zhǎng)字符串

在JS中，\也代表著續(xù)行符。Google的代碼規(guī)范不允許在不管是模板字符串還是普通字符串中使用續(xù)行符。盡管ES5中允許這么做，但如果在\后跟著某些結(jié)束空白符，這種行為會(huì)導(dǎo)致一些錯(cuò)誤，而這些錯(cuò)誤在審閱代碼時(shí)很難注意到。

這條規(guī)則很有趣，因?yàn)锳irbnb的規(guī)范中有一條與之不相同的規(guī)則

Google推薦下面這樣的寫法，而Airbnb則認(rèn)為應(yīng)該順其自然，不做特殊處理，該多長(zhǎng)就多長(zhǎng)。 

// bad (建議在PC端閱讀)  
const longString = 'This is a very long string that \  
    far exceeds the 80 column limit. It unfortunately \  
    contains long stretches of spaces due to how the \  
    continued lines are indented.';  
// good  
const longString = 'This is a very long string that ' +   
    'far exceeds the 80 column limit. It does not contain ' +   
    'long stretches of spaces since the concatenated ' +  
    'strings are cleaner.'; 

優(yōu)先使用for...of

在ES6中，有3種不同的for循環(huán)。盡管每一種有它的應(yīng)用場(chǎng)景，但Google仍推薦使用for...of。

真有趣，Google居然會(huì)特別指定一種for循環(huán)。雖然這很奇怪，但不影響我接受這一觀點(diǎn)。

以前我認(rèn)為for...in適合遍歷Object，而for...of適合遍歷數(shù)組。因?yàn)槲蚁矚g這種各司其職的使用方式。

盡管Google的規(guī)范與這種使用方式相沖突，但Google對(duì)for...of的偏愛(ài)依然讓我覺(jué)得十分有趣。

不要使用eval語(yǔ)句

除非是在code loader中，否則不用使用eval或是Function(...string)結(jié)構(gòu)。這個(gè)功能具有潛在的危險(xiǎn)性，并且在CSP環(huán)境中無(wú)法起作用。

MDN中有一節(jié)專門提到不要使用eval語(yǔ)句。 

// bad  
let obj = { a: 20, b: 30 };  
let propName = getPropName();  // returns "a" or "b"  
eval( 'var result = obj.' + propName );  
// good  
let obj = { a: 20, b: 30 };  
let propName = getPropName();  // returns "a" or "b"  
let result = obj[ propName ];  //  obj[ "a" ] is the same as obj.a 

常量的命名規(guī)范

常量命名應(yīng)該使用全大寫格式，并用下劃線分割

如果你確定一定以及肯定一個(gè)變量值以后不會(huì)被修改，你可以將它的名稱使用全大寫模式改寫，暗示這是一個(gè)常量，請(qǐng)不要修改它的值。

遵守這條規(guī)則時(shí)需要注意的一點(diǎn)是，如果這個(gè)常量是一個(gè)函數(shù)，那么應(yīng)該使用駝峰式命名法。 

// bad  
const number = 5;  
// good  
const NUMBER = 5; 

每次只聲明一個(gè)變量

每一個(gè)變量聲明都應(yīng)該只對(duì)應(yīng)著一個(gè)變量。不應(yīng)該出現(xiàn)像let a = 1,b = 2;這樣的語(yǔ)句。 

// bad  
let a = 1, b = 2, c = 3;  
// good  
let a = 1;  
let b = 2;  
let c = 3; 

使用單引號(hào)

只允許使用單引號(hào)包裹普通字符串，禁止使用雙引號(hào)。如果字符串中包含單引號(hào)字符，應(yīng)該使用模板字符串。 

// bad  
let directive = "No identification of self or mission."  
// bad  
let saying = 'Say it ain\u0027t so.';  
// good  
let directive = 'No identification of self or mission.';  
// good  
let saying = `Say it ain't so`; 

總結(jié)

就像我在開(kāi)頭所說(shuō)那樣，規(guī)范中沒(méi)有需要強(qiáng)制執(zhí)行的命令。盡管Google是科技巨頭之一，但這份代碼規(guī)范也僅僅是用來(lái)當(dāng)作參考罷了。

Google是一家人才匯聚的科技公司，雇傭著出色的程序員來(lái)編寫優(yōu)秀的代碼。能夠看到這樣的公司發(fā)布的代碼規(guī)范是一件很有趣的事情。

如果你想要實(shí)現(xiàn)一種Google式的代碼，那么你可以在項(xiàng)目中制定這些規(guī)范。但你可能并不贊成這份代碼規(guī)范，這時(shí)也沒(méi)有人會(huì)阻攔你舍棄其中某些規(guī)則。

我個(gè)人認(rèn)為在某些場(chǎng)景下，Airbnb的代碼規(guī)范比Google的代碼規(guī)范要出色。但不管你支持哪一種，也不管你編寫的是什么類型的代碼，最重要的是在腦海中時(shí)刻遵守著同一份代碼規(guī)范。