我們通常會替 CSS、HTML 的命名與結構訂規範,卻很少認真對待 JavaScript 的風格。但腳本寫得亂,維護成本同樣可觀。
它指的是:一個月後的你,寫出來的程式碼風格和一個月前保持一致;同一個團隊裡,不同成員寫出的腳本看起來像同一個人寫的。
因為我們幾乎不可能永遠孤立地開發。你隨時會遇到這幾種情況:
客戶三個月後要求改版,你要接手自己當初的程式碼——那時的你已經不記得當時為什麼那樣寫。團隊裡的同事要和你共同開發同一個專案,風格不同會讓合併與 review 變成折磨。你可能被指派去修改一位已離職同事留下的腳本,只能靠命名與結構推測他的意圖。反過來,你也可能扔下一個專案給後來的同事。
把命名規則(變數用 camelCase 還是 snake_case)、括號與縮排風格、註解密度的共識寫進文件,並用 editorconfig 或 linter 強制執行。工具會檔住大多數爭議,讓 review 聚焦在邏輯而不是排版。
更根本的一點是:寫給未來的自己看。任何一段不直觀的程式碼,都值得補上一行說明「為什麼這樣做」,而不只是「做了什麼」。