Try   HackMD

cleanCode - 有意義的命名

一、避免誤導

  • 避免使用 List 這種包含形態的命名
    ex: accountList -> accountGroup, bunchOfAccount

  • 避免使用太過相似的命名
    ex:
    (button, bottom),
    (XYZControllerForEfficientStorageOfString, XYZControllerForEfficientHandkingOfString)

  • 產生有意義的區別

    • 避免使用數字命名。 ex: a1,a2,a3
    • 避免使用無意義的區別。 ex: productInfo, productData
    • 透過 a 代表區域變數,the 代表全域變數
    • 容易混肴的變數命名。
      ex: *custom & customerObject,
      account & accountData,
      theMessage & message,
      getActiveAccount & getActiveAccounts & getActiveAccountInfo
  • 使用能唸出來的名稱

  • 使用可以被搜尋的名稱。
    自身的例子,使用 sass 時,_item 都找不太到
    避免只有使用 index, item 這樣的變數的短命名

  • 類別的命名
    應該為名詞或名詞片語,避免使用 manage,proccessor,data,info

  • 方法的命名
    應為動詞或動詞片語,取出器 get 當字首,修改器 set 當字首,判定 is 當字首

  • 添加有意義的上下文資訊