JavaScript 至今沒有一份官方權威的編碼規範,取而代之的是業界流傳的幾套熱門風格指南。本文彙整了六份廣受推崇的風格規範,並從中歸納出開發者普遍認同的共識,幫助你打造團隊統一、可讀性高的程式碼。
這六份指南分別是:Google 的 JavaScript 風格指南、NPM 編碼風格、Felix 的 Node.js 風格指南、慣用(Idiomatic)的 JavaScript、jQuery JavaScript 風格指南,以及 Web 開發領域權威 Douglas Crockford 的風格指南。此外,JSLint 與 JSHint 這類語法檢查器也內建了一些預設選項。那麼,究竟什麼才是大多數開發者都能遵循的終極風格呢?
縮進:Google、NPM、Node.js、Idiomatic 主張使用兩個空格,無需 Tab;jQuery 使用 Tab;Crockford 則採四個空格。
參數與運算式間的空格:Google、NPM、Node.js 採用緊湊風格:
project.MyClass = function(arg1, arg2) {
Idiomatic 與 jQuery 則偏好較多的空格:
for ( i = 0; i < length; i++ ) {
程式碼行長度:Google、NPM、Node.js、Crockford 建議每行最多 80 個字元;jQuery 與 Idiomatic 未提及。
分號:Google、Node.js、Crockford 主張始終使用分號,不依賴隱式插入;NPM 則在部分情況下不建議使用。
註解:Google 與 Idiomatic 遵循 JSDoc 約定。
引號:Google、Node.js 推薦單引號;jQuery 使用雙引號。
變數宣告:Node.js 建議一次宣告一個變數:
var foo = '';
var bar = '';
Idiomatic 與 jQuery 主張一次宣告多個,以逗號分隔:
var foo = "",
bar = "",
quux;
大括號:所有指南都同意左大括號與關鍵字同行:
function thisIsBlock(){
全域變數:Google 與 Crockford 強烈建議避免使用全域變數,因為命名衝突難以除錯,專案整合時也容易出現棘手問題。
變數命名:採用小駝峰式(首字小寫,後續單詞首字母大寫):
var foo = "";
var fooName = "";
常數命名:全部大寫,如:
var CONS = 'VALUE';
函數命名:建議使用具描述性的長名稱,或採用 isReady、setName、getName 等關鍵字形式。
陣列命名:Idiomatic 建議使用複數形式,如 var documents = [];。
物件與類命名:採用大駝峰式,如 var ThisIsObject = new Date;。
JSHint 是一款語法與風格檢查工具,能很好地整合進常用編輯器,是統一團隊風格的利器。你可以建立如下的 .jshintrc 檔案並放到專案根目錄:
{
"camelcase" : true,
"indent": 2,
"undef": true,
"quotmark": single,
"maxlen": 80,
"trailing": true,
"curly": true
}
此外,建議在瀏覽器環境的 JS 檔案開頭加上:
/* jshint browser:true, jquery:true */
Node.js 檔案則加上:
/*jshint node:true */
還可在各類 JS 檔案中宣告:
'use strict';
若想確保所有 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