變數（函式）命名最佳實踐

良好命名的必要

1. 程式碼命名是件很頭疼的事情，既要語義化又要簡潔，最終目的為了程式碼的可維護性
2. 合適的命名會使程式碼讀起來優雅流暢、耐人尋味，讓你的程式碼如藝術品一般。比如：
   • promise - 非同步請求資料時，“承諾”一定會回應（成功或失敗），很有畫面感
   • on/off - jquery 中表示監聽和銷燬事件，言簡意賅，方便易用
   • fork - github 的 fork 操作，由“叉子”引申為復刻屬於自己的分叉，形象生動

良好命名的要點

1. 使用能夠表達意圖的名字

   良好命名能夠告訴我們它要做什麼，為什麼存在，以及是如何工作的。選擇能夠表達意圖的名字，有利於我們清楚理解程式含義。相反，名不副實則會誤導閱讀程式碼的人，有時需要打斷點才能判斷出程式的真實功能。

2. 不要怕在選擇名字上花時間

   多嘗試幾種不同的名字，直到足以描述程式含義，不要害怕在命名上花時間。以後閱讀你程式碼的人（包括自己）會因此受益。而且，一個具有清晰描述性的命名，還有助於你在心中理清模組的設計。良好的命名可能需要花費額外的時間，但是從長遠來看，利大於弊。

3. 類名

   類名應該是個名詞或名詞片語，如 Customer、Account、AddressParser。父類的命名應該簡短，子類的應該詳盡，透過形容詞來描述其不同於父類之處，如 SavingsAccount 繼承自 Account。

4. 變數名

   變數名一般應該是名詞。如果是布林變數，應寫成謂詞的形式，如 isEmpty，這樣放到if 語句才便於理解。

5. 方法名

   方法名應該是一個動詞或動詞片語，如 sendMessage()、getUser()、save()。訪問器和設定器應該分別帶有 get 和 set 字首。返回布林值的方法應該字首 is，如 isPostable()。

常用動詞、對仗詞

常用名詞

常用縮寫

建議在 css 中命名多用縮寫，在 js 中根據實際場景選擇是否使用

常用字首

常用字尾

佈局相關

元件相關

參考文章