目前流行的JavaScript程式碼風格指南_javascript技巧

JavaScript 沒有一個權威的編碼風格指南，取而代之的是一些流行的編碼風格：

複製程式碼 程式碼如下:

Google的JavaScript風格指南（以下簡稱Google）
http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml
NPM編碼風格（以下簡稱NPM）
https://npmjs.org/doc/coding-style.html
Felix的Node.js風格指南（以下簡稱Node.js）
http://nodeguide.com/style.html
慣用（Idiomatic）的JavaScript（以下簡稱Idiomatic）
https://github.com/rwldrn/idiomatic.js/
jQuery JavaScript風格指南（以下簡稱jQuery）
http://contribute.jquery.org/style-guide/js/
Douglas Crockford的JavaScript風格指南（以下簡稱Crockford），Douglas Crockford是Web開發領域最知名的技術權威之一，ECMA JavaScript 2.0標準化委員會委員
http://javascript.crockford.com/code.html

當然，在JavaScript語法檢查器 JSLint 和 JSHint 中也有一些預設的設定選擇。問題是，什麼才是終極的、讓大多數開發者可以遵循的JavaScript程式設計風格呢？以下讓我們從這6個風格指南中找出一些有共識的風格來。

1. 程式碼風格比較

1.1 縮排

兩個空格，無需更長的縮進，無需Tab縮排：Google、NPM、Node.js、Idiomatic
Tab縮排：jQuery
4個空格：Crockford

1.2 參數與表達式之間的空格

使用緊湊型風格：Google、NPM、Node.js

複製程式碼 程式碼如下:

project.MyClass = function(arg1, arg2) {

過度使用空格：Idiomatic, jQuery

複製程式碼 程式碼如下:

for ( i = 0; i

沒有發表意見：Crockford 在大部分指南中，都提醒開發者不要在語句結尾處有任何的空格。

1.3 程式碼行長度

最多80個字元：Google、NPM、Node.js、Crockford（當在程式碼區塊中，除了2個空格外的其他縮排允許將函數參數與首個函數參數的位置對齊。另一種選擇是當自動換行時使用4個空格縮進，而不是2個。 沒有發表意見：jQuery、Idiomatic

1.4 分號

總是使用分號，不依賴隱式插入：Google、Node.js、Crockford
在某些情況下不要使用expect：NPM
沒有發表意見：jQuery、Idiomatic

1.5 註

遵循JSDoc約定：Google、Idiomatic
沒有發表意見：NPM、Node.js、jQuery、Crockford

1.6 引號

推薦單引號：Google、Node.js
雙引號：jQuery
沒有發表意見：NPM、Idiomatic、Crockford

1.7 變數宣告

一次宣告一個，不使用逗號：Node.js

複製程式碼 程式碼如下:

var foo = ”;
var bar = ”;

一次宣告多個，在行結束處使用逗號分隔：Idiomatic、jQuery

複製程式碼 程式碼如下:

var foo = “”,
bar = “”,
quux;

在行開始處使用逗號：NPM
沒有發表意見：Google、Crockford

1.8 大括號

在同一行使用左大括號：Google、NPM、Node.js、Idiomatic、 jQuery、Crockford

複製程式碼 程式碼如下:

function thisIsBlock(){

NPM指南中指出，只在程式碼區塊需要包含下一行時才使用大括號，否則不使用。

1.9 全域變數

不要使用全域變數：Google、Crockford（Google表示，全域變數命名衝突難以調試，並可能在兩個專案進行正整合時出現一些棘手的問題。為了便於共享公用的JavaScript程式碼，需要製定公約來避免衝突發生。

沒有發表意見：Idiomatic、jQuery、NPM、Node.js

2 命名風格

2.1 變數命名

開始的第一個字小寫，之後的所有字首大寫：Google、NPM、Node.js、Idiomatic

複製程式碼 程式碼如下:

var foo = “”;
var fooName = “”;

2.2 常數命名

使用大寫字母：Google、NPM、Node.js

複製程式碼 程式碼如下:

var CONS = ‘VALUE';

沒有發表意見：jQuery、Idiomatic、Crockford
2.3 函數命名

開始的第一個字小寫，之後的所有字首大寫（駝峰式）：Google、NPM、Idiomatic、Node.js（建議使用長的、具描述性的函數名）

複製程式碼 程式碼如下:

function veryLongOperationName
function short()..

關鍵字形式的函數命名：

複製程式碼 程式碼如下:

function isReady()
function setName()
function getName()

沒有發表意見：jQuery、Crockford
2.4 數組命名

使用複數形式：Idiomatic

複製程式碼 程式碼如下:

var documents = [];

沒有發表意見：Google、jQuery、NPM、Node.js、Crockford
2.5 物件與類別命名

使用以下形式：Google、NPM、Node.js

複製程式碼 程式碼如下:

var ThisIsObject = new Date;

沒有發表意見：jQuery、Idiomatic、Crockford
2.6 其他命名

針對長檔名和組態鍵使用all-lower-hyphen-css-case形式：NPM

3. 依照上述風格配置 .jshintrc 檔案

JSHint（

http://www.jshint.com/）是一個JavaScript語法和風格檢查工具，你可以用它來提醒程式碼風格相關的問題。它可以很好地被整合到許多常用的編輯器中，是統一團隊編碼風格的一個很好的工具。

你可以透過JSHint文件查看可用的選項：

http://www.jshint.com/docs/#options 下面根據以上每個分類下的第一種風格來建立一個 .jshintrc 檔案。你可以將它放到專案的根目錄中，JSHint-avare 程式碼編輯器將會按照它來統一專案中的所有程式碼風格。

複製程式碼 程式碼如下:

{
  "camelcase" : true,
  "indent": 2,
  "undef": true,
  "quotmark": single,
  "maxlen": 80,
  "trailing": true,
  "curly": true
}

此外，你應該將下面的頭加入你的 JavaScript 檔案：

複製程式碼 程式碼如下:

/* jshint browser:true, jquery:true */

在 Node.js 檔案中你應該要加：

複製程式碼 程式碼如下:

/*jshint node:true */

也可以在各種 JavaScript 檔案中加入下面的聲明：

複製程式碼 程式碼如下:

‘use strict';

這將影響 JSHint 和你的 JavaScript 引擎，可能不那麼相容，但 JavaScript 將會運行得更快。

4. 在提交 Git 之前自動執行 JSHint

如果你想確保所有的JS 程式碼與.jshintrc 中定義的風格保持一致，你可以將下面的內容添加到你的.git/hooks/pre-commit檔案中，當你試圖提交任何新修改的文件到專案時會自動執行風格檢查。

複製程式碼 程式碼如下:

#!/bin/bash
# Pre-commit Git hook to run JSHint on JavaScript files.
#
# If you absolutely must commit without testing,
# use: git commit --no-verify

filenames=($(git diff --cached --name-only HEAD))

which jshint &> /dev/null
if [ $? -ne 0 ];
then
  echo "error: jshint not found"
  echo "install with: sudo npm install -g jshint"
  exit 1
fi

for i in "${filenames[@]}"
do
    if [[ $i =~ .js$ ]];
    then
        echo jshint $i
        jshint $i
        if [ $? -ne 0 ];
        then
            exit 1
        fi
    fi
done