在團隊開發中,JavaScript 若缺乏規範,後續維護成本會快速升高。以下整理實務上常見的程式碼規範,重點在於可讀性、可維護性與效能。
大型專案常會在發布前壓縮 JavaScript。若程式碼沒有正確結尾、括號不完整或語法依賴註解,壓縮後可能出錯。

團隊成員應能用開發工具快速格式化程式碼。統一的縮排、換行與空格,能降低閱讀成本。

清楚的註解可協助其他人理解參數、回傳值與使用方式,也方便日後維護。

具描述性的命名能提升可讀性。例如用 lis 表示 li 集合,比單純用 li 更能表達複數概念。

動態語言很靈活,但過度壓縮語句會降低可讀性。例如把條件判斷塞進 && 表達式中,短期看似聰明,長期卻難以維護。
變數名稱與函式名稱應以清楚、通用的命名為主。若確實需要顯示中文,應放在字串或資料層,而不是程式語法中。
函式應清楚列出預期參數,而不是完全依賴 arguments。這能讓呼叫者快速理解函式用途。
動態綁定很強大,但若專案維護優先,直接標記事件或清楚的事件委派反而更容易理解。

不要依賴按鈕文字或 innerHTML 來判斷行為。應把不同功能拆成不同函式,讓程式碼更穩定。
若函式預期回傳字串,找不到資料時也應回傳空字串,而不是突然回傳 false,避免呼叫端需要額外判斷。
JSON 屬性名稱與字串值建議使用雙引號,這能提升相容性,也方便工具解析。

重構後留下的舊程式碼會造成混淆。若暫時保留,應明確標記為不建議使用。
若團隊已有 Common.js 或工具函式庫,應優先複用,而不是在每個模組中重複造輪子。
例如已知回傳格式為 JSON,就應使用對應的 JSON 請求方法,而不是取得文字後再自行解析。
若要保存暫存資料,應選擇隱藏欄位、全域變數或適當的資料結構,而不是任意塞進非顯示用途的標籤。
避免重複查詢 DOM、重複計算或建立不必要的物件。效能優化應成為日常習慣。
能把需求拆分成清楚的函式與模組,是工程師的重要能力。結構清晰的程式碼,後續維護與擴充都更容易。
作者:WebFlash
出處:https://webflash.cnblogs.com