本文整理大部分公認、或鮮少爭議的 JavaScript 良好撰寫規範。一些顯而易見的常識(例如要用物件特性偵測而非瀏覽器偵測、別把條件巢狀得太深)就不再贅述,條目大致依重要度由高到低排列。
我們的目標一致:讓使用者越快看到內容越好。載入腳本時 HTML 會停止解析,直到腳本載入完成,使用者可能對著空白螢幕乾等。若你的 JS 只是增加一些功能(如按鈕點擊),就大膽把引用放在 </body> 之前吧,你會看到明顯的速度提升。
// 糟糕:每次都重新計算長度
for (var i = 0; i < names.length; i++) { ... }
// 更好:只計算一次
var all = names.length;
for (var i = 0; i < all; i++) { ... }
// 更簡潔
for (var i = 0, j = names.length; i < j; i++) { ... }
此外,別把變數宣告寫在迴圈體內,那樣每次迭代都會重建變數;應在迴圈外先宣告好。
// 冗長 → 簡潔
var direction = (x > 100) ? 1 : -1;
// 判斷賦值
var x = v || 10;
// 用物件字面值取代反覆的變數名
var cow = { colour: 'brown', feet: 4, moo: function(){ console.log('moo'); } };
為避免混亂,建議在 HTML 中使用雙引號,在 JavaScript 中使用單引號。
樣式化的事交給 CSS,別在 JS 裡逐一設定 style;大量 HTML 內容用 Ajax 載入獨立檔案,而非用 JS 硬拼 DOM,後者難以維護。
別依賴瀏覽器的寬容解析而養成懶散習慣,可用 JSLint 這類線上工具檢測程式碼品質與結構問題。
檢查方法的輸入,一方面是安全,一方面是可用性。使用者隨時可能輸入錯誤資料,用 typeof 檢測輸入是否合法。
同頁所有 JS 都在同一個域中執行,全域變數與函式會被後載入的腳本覆蓋。解法是用匿名函式包起來,或放進自訂的命名空間:
(function(){
var current = null;
function init(){...}
})();
漏寫 var 會不小心建立或污染全域變數,可能造成難以追查的 bug。
var total = (+theform.elements["val1"].value) + (+theform.elements["val2"].value);
因為 + 既是加法也是字串串接,表單取值往往是字串,前面加個 + 就是給 JS 一個「這是數字」的暗示。
eval() 會把字串當程式碼執行,基於安全與效能,幾乎任何時候都有更好的替代方案。一句話:eval is evil。
for (key in object) {
if (object.hasOwnProperty(key)) { ... }
}
省略它們可能導致解析出人意料的結果,養成補上的好習慣。
點號的屬性名是硬編碼、無法在執行時變動;方括號則可傳入變數或函式回傳值,如 MyObject["value" + i]。
YUI、jQuery、Dojo 等函式庫相容性強、程式碼更簡潔,但別在同一專案全用上以免衝突;小規模使用時,原生 JS 反而更快。
這些規範環環相扣,核心精神不外乎:讓程式碼更快、更短、更安全、更好維護。養成這些習慣,寫出來的 JavaScript 自然會更專業、更可靠。