如果你寫的代碼只是給自己看，不需要與多人共同協(xié)作；如果你寫的代碼不打算開源；如果你不進(jìn)行code review；如果你不打算擔(dān)任前端工程師這一崗位，只是單純業(yè)余愛好；滿足以上任一條件，我建議你編碼不需要規(guī)范，怎么隨性怎么來(lái)，編碼規(guī)范束縛你的自由！

顯然，大多數(shù)人都不是以上的情況！那么javascript編碼規(guī)范就能解決以上的問(wèn)題，還能夠增強(qiáng)代碼的簡(jiǎn)潔性、可讀性、可擴(kuò)展性。項(xiàng)目做到后期，每修改一次，所耗費(fèi)的成本就越高，編碼規(guī)范能節(jié)省這樣的成本，并且能很好拓展升級(jí)原有系統(tǒng)功能。javascript編碼規(guī)范也是開源社區(qū)大家約定俗成的規(guī)則！

編碼規(guī)范前言

1、命名

“名副其實(shí)”——只做有意義的命名，規(guī)則如下：

    可讀
    可搜索
    為相同類型的變量使用統(tǒng)一命名
    在解構(gòu)中命名
    力求精簡(jiǎn)，不添加不必要的上下文
    屬性、變量名、類名使用名詞，函數(shù)名使用動(dòng)詞

2、函數(shù)

    短小
    只做一件事
    函數(shù)名使用動(dòng)詞，要能夠說(shuō)明它要做什么
    函數(shù)的參數(shù)不應(yīng)該超過(guò)三個(gè)
    函數(shù)式編程優(yōu)于指令式編程

3、注釋

    不要多余
    注釋是對(duì)意圖的解釋

4、格式化

    格式化是主觀的，但是團(tuán)隊(duì)內(nèi)應(yīng)該保持一致
    使用一致的大小寫
    函數(shù)的調(diào)用方與被調(diào)用方應(yīng)該靠近：從上到下閱讀代碼
    借助 Format 工具

5、對(duì)象和數(shù)據(jù)結(jié)構(gòu)

使用 getters 和 setters 能更好的處理對(duì)象及其數(shù)據(jù)結(jié)構(gòu)

    使用 set 可以讓驗(yàn)證變得更容易
    封裝內(nèi)部實(shí)現(xiàn)
    繼承這個(gè)類， 你可以重寫默認(rèn)功能
    使用 getting 和 setting 時(shí)， 容易添加日志和錯(cuò)誤處理

6、單元測(cè)試

測(cè)試比發(fā)布更加重要。如果你沒(méi)有測(cè)試或者測(cè)試不夠充分，每次發(fā)布時(shí)你就不能確認(rèn)沒(méi)有破壞任何事情。

    測(cè)試必須具備：可讀性。
    測(cè)試遵循 F(ast).I(ndependent).R(epeatable).S(elf-Validating).T(imely)。

1 縮進(jìn)

每一行的層級(jí)由4個(gè)空格組成，避免使用制表符縮進(jìn)。

2 行的長(zhǎng)度

每行長(zhǎng)度不超過(guò)80個(gè)字符，如果超過(guò)，應(yīng)當(dāng)在一個(gè)運(yùn)算符（逗號(hào)，加號(hào)等）后換行。下一行應(yīng)當(dāng)增加兩級(jí)縮進(jìn)（8個(gè)空格）。

//好的寫法
doSomething(arguments1, arguments2, arguments3, arguments4,
    arguments5)

3 運(yùn)算符的行間距

二元運(yùn)算符前后必須使用一個(gè)空格來(lái)保持表達(dá)式的整潔。操作符包括賦值運(yùn)算符和邏輯運(yùn)算符。

var found = (values[0] === item);

if(found && (count > 10))；

for(var i = 0; i < count; i++)

4 括號(hào)間距

當(dāng)使用括號(hào)時(shí)，緊接左括號(hào)之后和緊接右括號(hào)之前不應(yīng)該有空格。

5 對(duì)象直接量

對(duì)象直接量應(yīng)當(dāng)使用如下格式：

起始左花括號(hào)應(yīng)當(dāng)同表達(dá)式保持一行每個(gè)屬性的名值對(duì)應(yīng)當(dāng)保持一個(gè)縮進(jìn)，第一個(gè)屬性應(yīng)當(dāng)在左花括號(hào)后另起一行每個(gè)屬性的名值對(duì)應(yīng)當(dāng)使用不含引號(hào)的屬性名，其后緊跟一個(gè)冒號(hào)（之前不含空格），而后是值倘若屬性值是函數(shù)類型，函數(shù)體應(yīng)當(dāng)在屬性名之下另起一行，而且其前后就均保留一個(gè)空格一組相關(guān)的屬性前后可以插入空行以提升代碼的可讀性結(jié)束的右花括號(hào)應(yīng)當(dāng)獨(dú)占一行

var obj = {
  
  key1: value1,
  
    key2: value2,
  
    func: function() {
    
    },
  
    key3: value3
};

當(dāng)對(duì)象字面量作為函數(shù)參數(shù)時(shí)，如果值是變量，其實(shí)花括號(hào)應(yīng)當(dāng)同函數(shù)名在同一行，所有其實(shí)先前列出的規(guī)則同樣適用

//好的寫法
doSomething({
  key1: value1,
    key2: value2
})
//不好的寫法
doSomething({key1: value1,key2: value2})

6 注釋

頻繁地使用注釋有助于他人理解你的代碼，如下情況應(yīng)當(dāng)使用注釋：

代碼晦澀難懂可能被誤認(rèn)為錯(cuò)誤的代碼必要但并不明顯的針對(duì)特定瀏覽器的代碼對(duì)于對(duì)象、方法或者屬性，生成文檔是有必要的（使用恰當(dāng)?shù)奈臋n注釋）

6.1 單行注釋

單行注釋應(yīng)當(dāng)用來(lái)說(shuō)明一行或者一組相關(guān)的代碼。單行注釋可能有如下三種使用方式：

獨(dú)占一行的注釋，用來(lái)解釋下一行代碼在代碼行的尾部注釋，用來(lái)解釋它之前的代碼多行，用來(lái)注釋掉一個(gè)代碼塊

//好的寫法
if(condition){
  
  //如果代碼執(zhí)行到這里，則表明通過(guò)了所有的安全檢查
  allowed()
}

//不好的寫法:注釋前沒(méi)有空行
if(condition){
  //如果代碼執(zhí)行到這里，則表明通過(guò)了所有的安全檢查
  allowed()
}
//不好的寫法:錯(cuò)誤的縮進(jìn)
if(condition){

//如果代碼執(zhí)行到這里，則表明通過(guò)了所有的安全檢查
  allowed()
}

對(duì)于行尾的情況，代碼和注釋間至少一個(gè)空格

//好的寫法
var a = 10; // 這里是注釋
//不好的寫法
var a = 10;// 這里是注釋

6.2 多行注釋

多行注釋應(yīng)當(dāng)在代碼需要更多的文字去解釋的時(shí)候使用。每個(gè)多行注釋應(yīng)當(dāng)有如下三行

首行僅僅包含/*注釋開始，該行不能有其他文件接下來(lái)的行*開頭并保持左對(duì)齊。這些行可以有文字描述最后一行以*/結(jié)束并與先前行對(duì)齊。也不應(yīng)再有其他文字

多行注釋應(yīng)當(dāng)保持同它描述的代碼一樣的縮進(jìn)，后續(xù)每個(gè)*后加一個(gè)空格

//好的寫法
if (condition) {
  
  /*
  * 這里是說(shuō)明
  * 這也是
  * 打字真他媽累
  * 不好好看，我掐死你們
  */
    allowed();
}

7 變量聲明

所有變量在使用前都應(yīng)當(dāng)事先定義，使用一個(gè)var。

//好的寫法
var a = 1,
  b = 2,
  c = 3,
  d = 4;
//不好的寫法
var a = 1;
var b = 2;
var c = 3;
var d = 4;
//不好的寫法
var a = 1,
  b = 2,
  c = 3,
  d = 4;

未初始化值得變量在后面

//好的寫法
var a = 1,
  b,
  c;
// 不好的寫法
var b,
  c,
  a = 1;

8 函數(shù)聲明

函數(shù)應(yīng)當(dāng)在使用前提前定義，不是作為對(duì)象的方法的函數(shù)，應(yīng)當(dāng)使用函數(shù)聲明的格式（function聲明）

// 好的寫法
function fn(arg1, arg2) {
   
}
// 不好的寫法：不恰當(dāng)?shù)目崭?
function fn (arg1, arg2){
  
}
// 不好的寫法：花括號(hào)位置不對(duì)
function fn(arg1, arg2) 
{
   
}

函數(shù)內(nèi)的函數(shù)聲明，應(yīng)當(dāng)在var聲明后，立即定義。

//好的寫法
function outer() {
  
  var count = 10,
    name = 'fengyu',
    age = 18,
    empty;
    
  function inner() {
    
  }
}

匿名函數(shù)的自執(zhí)行

// 推薦使用
(function (){}());

// 其他的都不推薦。

9 命名

變量和函數(shù)命名時(shí)要小心。命名應(yīng)僅限于數(shù)字字母字符。某些情況可以使用下劃線。最好不好用美元符號(hào)(‘$’)和反斜杠(‘’)

變量命名采用駝峰式，首字母小寫，每個(gè)單詞首字母大寫，變量名的第一個(gè)單詞應(yīng)當(dāng)是一個(gè)名詞（而非動(dòng)詞）以避免和函數(shù)混淆，不要再變量名中使用下劃線。

// 好的寫法
var accountNumber = "1234567"；
// 不好的寫法：大寫字母開頭
var AccountNumber = "1234567"；
// 不好的寫法：動(dòng)詞開頭
var getAccountNumber = "1234567"；
//不好的寫法：使用下劃線
var account_Number = "1234567";

函數(shù)名也使用駝峰，第一個(gè)單詞應(yīng)當(dāng)是動(dòng)詞（而非名詞），也不要使用下劃線

// 好的寫法
function doSomething() {
  
}
// 不好的寫法:首字母大寫
function DoSomething() {
  
}
// 不好的寫法:名詞
function car() {
  
}
// 不好的寫法：下劃線
function do_something() {
  
}

構(gòu)造函數(shù)才能首字母大寫，名稱應(yīng)當(dāng)非動(dòng)詞開頭

// 好的寫法
function MyObject() {
  
}
// 不好的寫法：首字母小寫
function myObject() {
  
}
// 不好的寫法：動(dòng)詞開頭
function getMyObject() {
  
}

常量（值不會(huì)被改變的變量）命名應(yīng)當(dāng)是全部大寫，不同單詞用下劃線隔開

// 好的寫法
var TOTAL_COUNT = 10;
// 其他都是不好的寫法

對(duì)象的屬性同變量的命名規(guī)則相同。對(duì)象的方法同函數(shù)的命名規(guī)則相同，如果屬性或者方法是私有（不希望別人訪問(wèn)），應(yīng)當(dāng)在之前加一個(gè)下劃線

// 好的寫法
var object = {
  _count: 10,
  
  _getCount: function (){
    return this._count;
    }
}

10 嚴(yán)格模式

嚴(yán)格模式應(yīng)當(dāng)僅限在函數(shù)內(nèi)部使用，千萬(wàn)不要在全局使用。

// 不好的寫法：全局使用嚴(yán)格模式
"use strict";

function doSomething() {
  //code
};

// 好的寫法
function doSomething() {
    "use strict";
    
    //code
};

如果你期望在多個(gè)函數(shù)里使用嚴(yán)格模式而不需要多次聲明“use strict”，可以使用立即執(zhí)行的函數(shù)。

(function (){
    "use strict";
    
  function doSomething() {
    
  };
  
  function doSomethingElse() {
    
  };
}());

11 賦值

當(dāng)給變量賦值時(shí)，如果右側(cè)時(shí)含有比較語(yǔ)句的表達(dá)式，需要使用圓括號(hào)包裹。

// 好的寫法
var flag = (i < count);

//不好的寫法
var flag = i < count;

12 等號(hào)運(yùn)算符

使用===（嚴(yán)格等于）和！==（嚴(yán)格不相等）代替==（相等）和!=（不等）來(lái)避免弱類型轉(zhuǎn)換錯(cuò)誤。

// 好的寫法
var same = (a === b);

//不好的寫法
var same = (a == b);

13 三元運(yùn)算符

三元運(yùn)算符應(yīng)當(dāng)僅僅用在條件賦值語(yǔ)句中，而不要作為if的替代品。

// 好的寫法
var value = condition ? value1 : valule2;

// 不好的寫法
condition ? doSomething() : doSomethingElse();

14 語(yǔ)句

14.1 簡(jiǎn)單語(yǔ)句

每行最多只包含一條語(yǔ)句。所有簡(jiǎn)單的語(yǔ)句都應(yīng)該以分號(hào)結(jié)束

// 好的寫法
count++;
a = b;

// 不好的寫法
count++; a = b;

14.2 返回語(yǔ)句

返回語(yǔ)句當(dāng)返回一個(gè)值得時(shí)候不應(yīng)當(dāng)使用圓括號(hào)包裹，除非在某些情況下這么做可以讓返回值更容易理解，例如：

return;
return fengyu.length();
return (length > 18 ? length : 18);

14.3 復(fù)合語(yǔ)句

復(fù)合語(yǔ)句時(shí)大括號(hào)括起來(lái)得語(yǔ)句列表。

括起來(lái)得語(yǔ)句應(yīng)當(dāng)較符合語(yǔ)句多縮進(jìn)一個(gè)層級(jí)開始得大括號(hào)應(yīng)當(dāng)在符合語(yǔ)句所在行的末尾；結(jié)束的大括號(hào)應(yīng)當(dāng)獨(dú)占一行且同復(fù)合語(yǔ)句的開始保持一樣的縮進(jìn)當(dāng)語(yǔ)句是控制結(jié)構(gòu)的一部分時(shí)，諸如if或者for語(yǔ)句，所有的語(yǔ)句都需要用大括號(hào)括起來(lái)，也包括單個(gè)語(yǔ)句。這個(gè)約定是的我們更加方便地添加語(yǔ)句而不用擔(dān)心忘記加括號(hào)而引起bug。像if一樣的語(yǔ)句的開始的關(guān)鍵詞，其后應(yīng)該緊跟一個(gè)空格，起始大括號(hào)應(yīng)當(dāng)在空格之后 ??14.3.1 if語(yǔ)句

if語(yǔ)句應(yīng)當(dāng)是下面的格式

if (condition) {
    statements
}

if (condition) {
    statements1
} else {
    statements2
}

if (condition1) {
    statements1
} else if (condition2) {
    statements2
} else {
    statements3
}

絕不允許在if中省略花括號(hào)

// 好的寫法
if (condition) {
    doSomething();
}
//不好的寫法：不恰當(dāng)?shù)目崭?
if(condition){
    doSomething();
}
// 不好的寫法：省略花括號(hào)
if(condition)
    doSomething();
// 不好的寫法：代碼在一行
if (condition) {doSomething();}
// 不好的寫法：在一行還省略花括號(hào)
if (condition) doSomething();

??14.3.2 for語(yǔ)句

for類型的語(yǔ)句應(yīng)當(dāng)是下面的格式

for (initialization; condition; Step) {
    statements
}

for (variable in object) {
    statements
}

for語(yǔ)句的初始化部分不應(yīng)當(dāng)有變量聲明

// 好的寫法
var i,
  len;
for (i = 0, len = 10; i < len; i++) {
    //code
}

// 不好的寫法
for (var i = 0, len = 10; i < len; i++) {
    //code
}
for (var prop in object) {
    //code
}

14.3.3 while語(yǔ)句

while類的語(yǔ)句應(yīng)當(dāng)是下面格式

while (condition) {
  //code       
}

14.3.4 do…while語(yǔ)句

do類語(yǔ)句應(yīng)當(dāng)是下面格式

do {
  //code
} while (condition);

14.3.5 switch語(yǔ)句

格式如下：

#除了第一個(gè)case之外，包括default在內(nèi)的每一個(gè)case之前都應(yīng)當(dāng)有一個(gè)空行
switch (expression) {
    case exp1:
      //code
      break;
    
    case exp2:
      //code
      break;
    
    default:
      //code
      break;
}

如果一個(gè)switch不包含default的情況，應(yīng)當(dāng)用注釋代替

switch (expression) {
    case exp1:
      //code
      break;
    
    case exp2:
      //code
      break;
    
    // 沒(méi)有default
}

15 留白

在邏輯相關(guān)的代碼塊之間添加空行可以提高代碼的可讀性。

兩行空行僅限在如下情況中使用

在不同的源代碼文件之間在類和接口定義之間

單行空行僅限在如下情況中使用

方法之間

方法中局部變量和第一行語(yǔ)句中間

多行或者單行注釋之前

方法中邏輯代碼塊之間以提升代碼的可讀性

空格應(yīng)當(dāng)在如下情況中使用

關(guān)鍵詞后跟括號(hào)的情況應(yīng)當(dāng)用空格隔開

參數(shù)列表中逗號(hào)之后應(yīng)當(dāng)留一個(gè)空格

所有的除了點(diǎn)（.）之外的二元運(yùn)算符，其操作數(shù)都應(yīng)當(dāng)用空格隔開。單目運(yùn)算符的操作數(shù)事件不應(yīng)該用空白隔開，諸如一元減號(hào)，遞增(++)，遞減(–)

for語(yǔ)句中的表達(dá)式之間應(yīng)當(dāng)用空格隔開

16 需要避免的

切勿使用像String一類的原始包裝類型創(chuàng)建新的對(duì)象。

避免使用eval()

避免使用with語(yǔ)句（其實(shí)該語(yǔ)句已經(jīng)被廢除了）

17 關(guān)于命名

? 變量：必須采用小駝峰式命名法。

命名規(guī)范：前綴應(yīng)當(dāng)是名詞。(函數(shù)的名字前綴為動(dòng)詞，以此區(qū)分變量和函數(shù))

命名建議：盡量在變量名字中體現(xiàn)所屬類型，如:length、count等表示數(shù)字類型；而包含name、title表示為字符串類型。

// 好的命名方式
let maxCount = 10;
let tableTitle = 'LoginTable';
// 不好的命名方式
let setCount = 10;
let getTitle = 'LoginTable';

常量：必須采用全大寫的命名，且單詞以_分割，常量通常用于ajax請(qǐng)求url，和一些不會(huì)改變的數(shù)據(jù)

命名規(guī)范：使用大寫字母和下劃線來(lái)組合命名，下劃線用以分割單詞。

const MAX_COUNT = 10;
const URL = 'http://.com';

函數(shù)

• 命名方法：小駝峰式命名法。
• 命名規(guī)范：前綴應(yīng)當(dāng)為動(dòng)詞。
• 命名建議：可使用常見動(dòng)詞約定

// 是否可閱讀
function canRead(): boolean {
  return true;
}
// 獲取名稱
function getName(): string {
  return this.name;
}

類 & 構(gòu)造函數(shù)

命名方法：大駝峰式命名法，首字母大寫。

命名規(guī)范：前綴為名稱。

示例：

class Person {
  public name: string;
  constructor(name) {
    this.name = name;
  }
}
const person = new Person('mevyn');

類的成員

類的成員包含：

公共屬性和方法：跟變量和函數(shù)的命名一樣。私有屬性和方法：前綴為_(下劃線)，后面跟公共屬性和方法一樣的命名方式。

示例：

class Person {
  private _name: string;
  constructor() { }
  // 公共方法
  getName() {
    return this._name;
  }
  // 公共方法
  setName(name) {
    this._name = name;
  }
}
const person = new Person();
person.setName('mervyn');
person.getName(); // ->mervyn

18 注釋規(guī)范

js 支持三種不同類型的注釋：行內(nèi)注釋、單行注釋和多行注釋：

行內(nèi)注釋 說(shuō)明：行內(nèi)注釋以兩個(gè)斜線開始，以行尾結(jié)束。語(yǔ)法：code // 這是行內(nèi)注釋使用方式：//(雙斜線)與代碼之間保留一個(gè)空格，并且//(雙斜線)與注釋文字之間保留一個(gè)空格。

命名建議：

// 用來(lái)顯示一個(gè)解釋的評(píng)論
// -> 用來(lái)顯示表達(dá)式的結(jié)果，
// >用來(lái)顯示 console 的輸出結(jié)果，

示例：

function test() { // 測(cè)試函數(shù)
  console.log('Hello World!'); // >Hello World!
  return 3 + 2; // ->5
}

單行注釋 說(shuō)明：?jiǎn)涡凶⑨屢詢蓚€(gè)斜線開始，以行尾結(jié)束。語(yǔ)法：// 這是單行注釋使用方式：?jiǎn)为?dú)一行：//(雙斜線)與注釋文字之間保留一個(gè)空格。

示例：

// 調(diào)用了一個(gè)函數(shù)；1)單獨(dú)在一行
setTitle();

多行注釋 說(shuō)明：以 /* 開頭， */ 結(jié)尾語(yǔ)法：/* 注釋說(shuō)明 */使用方法：若開始/和結(jié)束/都在一行，推薦采用單行注釋。若至少三行注釋時(shí)，第一行為/，最后行為/，其他行以開始，并且注釋文字與保留一個(gè)空格。

示例:

/*
* 代碼執(zhí)行到這里后會(huì)調(diào)用setTitle()函數(shù)
* setTitle()：設(shè)置title的值
*/
setTitle();

函數(shù)(方法)注釋 說(shuō)明：函數(shù)(方法)注釋也是多行注釋的一種，但是包含了特殊的注釋要求，參照J(rèn)SDoc語(yǔ)法：

/** 
* 函數(shù)說(shuō)明 
* @關(guān)鍵字 
*/

常用注釋關(guān)鍵字：(只列出一部分，并不是全部)

/**
* 合并Grid的行
* @param grid {Ext.Grid.Panel} 需要合并的Grid
* @param cols {Array} 需要合并列的Index(序號(hào))數(shù)組；從0開始計(jì)數(shù)，序號(hào)也包含。
* @param isAllSome {Boolean} ：是否2個(gè)tr的cols必須完成一樣才能進(jìn)行合并。true：完成一樣；false(默認(rèn))：不完全一樣
* @return void
* @author polk6 2015/07/21 
* @example
* _________________                             _________________
* |  年齡 |  姓名 |                             |  年齡 |  姓名 |
* -----------------      mergeCells(grid,[0])   -----------------
* |  18   |  張三 |              =>             |       |  張三 |
* -----------------                             -  18   ---------
* |  18   |  王五 |                             |       |  王五 |
* -----------------                             -----------------
*/
function mergeCells(grid: Ext.Grid.Panel, cols: Number[], isAllSome: boolean = false) {
  // Do Something
}

不要保存 this 的引用。使用 Function#bind。

// bad
function () {
  var self = this;
  return function () {
    console.log(self);
  };
}

// bad
function () {
  var that = this;
  return function () {
    console.log(that);
  };
}

// bad
function () {
  var _this = this;
  return function () {
    console.log(_this);
  };
}

// good
function () {
  return function () {
    console.log(this);
  }.bind(this);
}

給函數(shù)命名。這在做堆棧軌跡時(shí)很有幫助。

// bad
var log = function (msg) {
  console.log(msg);
};

// good
var log = function log(msg) {
  console.log(msg);
};

如果你的文件導(dǎo)出一個(gè)類，你的文件名應(yīng)該與類名完全相同。

// file contents
class CheckBox {
  // ...
}
module.exports = CheckBox;

// in some other file
// bad
var CheckBox = require('./checkBox');

// bad
var CheckBox = require('./check_box');

// good
var CheckBox = require('./CheckBox');

19 模塊

模塊應(yīng)該以 ! 開始。這樣確保了當(dāng)一個(gè)不好的模塊忘記包含最后的分號(hào)時(shí)，在合并代碼到生產(chǎn)環(huán)境后不會(huì)產(chǎn)生錯(cuò)誤。

詳細(xì)說(shuō)明

文件應(yīng)該以駝峰式命名，并放在同名的文件夾里，且與導(dǎo)出的名字一致。

增加一個(gè)名為 noConflict() 的方法來(lái)設(shè)置導(dǎo)出的模塊為前一個(gè)版本并返回它。

永遠(yuǎn)在模塊頂部聲明 ‘use strict’;。

// fancyInput/fancyInput.js

!function (global) {
  'use strict';

  var previousFancyInput = global.FancyInput;

  function FancyInput(options) {
    this.options = options || {};
  }

  FancyInput.noConflict = function noConflict() {
    global.FancyInput = previousFancyInput;
    return FancyInput;
  };

  global.FancyInput = FancyInput;
}(this);

20 構(gòu)造函數(shù)

給對(duì)象原型分配方法，而不是使用一個(gè)新對(duì)象覆蓋原型。覆蓋原型將導(dǎo)致繼承出現(xiàn)問(wèn)題：重設(shè)原型將覆蓋原有原型！

function Jedi() {
  console.log('new jedi');
}

// bad
Jedi.prototype = {
  fight: function fight() {
    console.log('fighting');
  },

  block: function block() {
    console.log('blocking');
  }
};

// good
Jedi.prototype.fight = function fight() {
  console.log('fighting');
};

Jedi.prototype.block = function block() {
  console.log('blocking');
};

方法可以返回 this 來(lái)實(shí)現(xiàn)方法鏈?zhǔn)绞褂谩?/p>

// bad
Jedi.prototype.jump = function jump() {
  this.jumping = true;
  return true;
};

Jedi.prototype.setHeight = function setHeight(height) {
  this.height = height;
};

var luke = new Jedi();
luke.jump(); // => true
luke.setHeight(20); // => undefined

// good
Jedi.prototype.jump = function jump() {
  this.jumping = true;
  return this;
};

Jedi.prototype.setHeight = function setHeight(height) {
  this.height = height;
  return this;
};

var luke = new Jedi();

luke.jump()
  .setHeight(20);

21 小tips

代碼風(fēng)格有很多種，就拿縮進(jìn)來(lái)說(shuō)：

jQuery核心風(fēng)格指南明確規(guī)定使用制表符縮進(jìn)

Dauglas Crockford的JavaScript代碼規(guī)范規(guī)定使用4個(gè)空格字符縮進(jìn)

SproutCore風(fēng)格指南規(guī)定使用2個(gè)空格縮進(jìn)

Google的Javascript風(fēng)格指南規(guī)定使用2個(gè)空格縮進(jìn)

Dojo編程風(fēng)格指南規(guī)定使用制表符縮進(jìn)

因此，風(fēng)格很多，大致了解一下，以所在的團(tuán)隊(duì)風(fēng)格為準(zhǔn)。

總結(jié)

到此這篇關(guān)于JavaScript編碼風(fēng)格指南(編寫可維護(hù)的代碼規(guī)范)的文章就介紹到這了,更多相關(guān)JavaScript編碼規(guī)范內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！