好的編碼風格能讓程式碼更易讀、易維護。以下整理一套實用的 Node.js 撰寫規範,適合團隊開發時參考:
呼叫函數時,函數名與左括號之間不留空格;函數名與參數序列之間也不留空格;而其他語法元素與左括號之間則保留一個空格。
變數與屬性一律採用小駝峰式命名法。
縮進統一使用兩個空格,字串統一使用單引號。
關聯數組除非鍵名含空格或非法字元,否則一律不加引號。
不要把不同用途的語句合併成一行;也不要省略句末的分號,哪怕一行只有一句。
避免使用自增(++)與自減(--)運算子,改用 += 和 -= 代替。
避免使用「相等」(==)運算子,只使用「嚴格相等」(===)。
所有變數宣告都集中放在函數開頭;所有函數都在使用前定義。
盡量為構造函數與回調函數命名,這樣除錯時能看到更清晰的呼叫堆疊。
盡量把成員函數透過原型定義,屬性則在構造函數內定義,再用 new 關鍵字建立物件。
避免複雜的繼承;若需繼承,盡量使用 util 模組的 inherits 函數,例如 A 繼承 B 可寫成 util.inherits(A, B)。
參考資料:
《Node.js 開發指南》附錄 B(BYVoid)
JavaScript 編程風格(阮一峰)