【clean code】有意義的命名

  1. 名副其實,變量&函數&常量的命名應該明確表示其含義,不能模凌兩可。自解釋代碼
  2. 避免誤導
    a. 避免已有的標準命名,vim在寫代碼人的眼裏就是編輯器,如果你用來做變量就容易引起歧義。
    b. 避免類型誤導,只有確實是List的時候才能命名:ListXXX
  3. 不要用含義類似的名字來表示不同的東西,名字一定要有區分性。
  4. 使用讀得出來的名稱,讀不出來不適合長期記憶
  5. 使用可搜索的名稱,在代碼裏面檢索某個名稱是很常見的。如果給一個變量命名e,鬼知道你要花多少時間才能找到你要的那個e。
    a. 名字長度應該和其作用域的大小相對應。例如:5 = WORK_DAYS_PER_WEEK vs 某個函數內的sum
  6. 避免使用編碼:有些人喜歡通過編碼達到幫助記憶的效果?比如說類型|訪問
    a. 避免使用匈牙利標記法:一個變量名由一個或多個小寫字母開始,這些字母有助於記憶變量的類型和用途,緊跟着的就是程序設計師選擇的任何名稱。(from wikiPedia)。如此的命名方法是在代碼中進行特殊編碼的一種
    b. 不需要在名稱前通過前綴來表明成員變量&訪問。因爲他們本身不具有業務上的邏輯含義
    c. 接口前不要加“I”。
  7. 寫大家普遍認知中的名稱。避免思維映射:別人從你的命名的概念中映射到他們自己熟知的概念。
  8. 類名不應該是動詞
  9. 方法名應該是動詞或動詞短語:例如:
    a. postPayment,deletePage,save。
  10. 一個概念對應一個詞。避免多個詞對應一個概念或者一個詞對應多個概念。
  11. 使用領域名稱
  12. 添加有意義的語境。如果把變量名:firstName,lastName,street,houseNumber,city,state,zipcode。放在一起,你很容易就能聯想這其中的變量其實是在表示一個地址。但是如果把他們孤立出來,就會讓人摸不着頭腦。
  13. 不需要給名字添加不必要的語境。如果你正在寫一個和博物館相關的應用。給每一個類前面加上Museum肯定不是什麼好點子,這種語境天然存在。
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章