好的編碼規範不是為了好看,而是為了讓團隊成員在半年後還能讀懂彼此寫的程式。以下依命名、排版、註解、硬性規則與效能五個面向整理。
變數與函式名稱應傳達明確意圖,不要隨手取 a、tmp、data1。非建構函式建議採用駝峰命名並盡量使用動賓結構,例如 getName()、isFull(),這也能自然和變數名區分開。建構函式(自訂型別)的首字母大寫,例如 Person。
由於 JavaScript 是弱型別語言,可考慮在變數名前加上型別前綴:整數 i、浮點數 f、布林 b、字串 s、陣列 a。這不是強制規定,但一旦採用就必須貫徹——混用「加前綴」和「不加前綴」比兩者都不用更糟。
var 與變數名、變數名與等號、等號與初始值之間各留一個空格,分號前不留:var i = 10;var Person = {
age: 16,
name: "Sam"
};
function 與函式名之間留空格,函式名與括號之間不留,括號與大括號之間留一個if、while、for 與左括號之間留一個空格以強調關鍵字if、while、for 等區塊的左大括號不另起一行,與關鍵字同行註解不是越多越好,也不是完全不能有。重點是為重要的方法、不直觀的變數、以及需要特別說明的演算法加上說明。修改程式碼時必須同步更新註解,過時的註解比沒有註解更有害。另外,不要在 JavaScript 中使用 HTML 風格的註解語法。
宣告變數一定要加 var(或 let / const)。漏掉會意外產生全域變數,這是很常見的 bug 來源。
宣告時同時初始化,之後盡量不要改變變數的資料型別。
該加分號的地方就加分號,即使只有一條語句也要包在大括號裡。
節制使用全域變數。若確實需要,最好只保留一個全域命名空間物件。
保持三層分離:HTML 是資料層,CSS 是表現層,JavaScript 是行為層。HTML 中不要寫具體的 JavaScript,改用外部檔案;JavaScript 中盡量不要用 innerHTML 插入大量標籤,可考慮把元素寫在 HTML 中再控制顯示;JavaScript 也不要直接改 CSS 的個別屬性,而應透過 className 間接切換樣式。
不要修改不屬於你的物件。不隨意為內建物件的實例或原型添加屬性方法,也不要重複定義既有的方法。否則當該物件出新版本並加入同名成員時,會產生極難察覺的衝突。解法有兩種:繼承,或包成自己的型別。
用命名空間隔離不同函式庫,避免全域名稱互相覆蓋。
把字面量集中管理,模擬其他語言的常數列舉:
var Color = {
RED: 1,
BLUE: 2,
GREEN: 3
};
檢查傳入參數:基本型別用 typeof,參考型別用 instanceof;要確認某物件是否有某個方法,就對該方法用 typeof 並與字串 "undefined" 比較。
避免全域查找。全域變數與函式的存取成本比區域的高,因為涉及作用域鏈的搜尋。若函式內要多次使用某個全域變數,先把它指派給區域變數再用。
避免 with 語句。with 會建立自己的作用域,帶來額外開銷,也讓程式碼意圖變得模糊。
避免重複的屬性查找。屬性查找的成本隨深度線性增加,而變數與陣列存取接近常數時間。若同一個屬性要連續用多次,先存到區域變數:
var sUrl = window.location.href;
var sData = sUrl.substring(sUrl.indexOf("?"));
這些規則看似瑣碎,但累積在一個中大型專案上,差異會非常明顯。規範的價值不在於「寫出漂亮的程式碼」,而在於降低溝通成本與長期維護成本。