第二章 有意義的命名

2.2 名副其實

  1. 在代碼中體現(xiàn)上下文的語境,能夠知道這段代碼想干什么;

2.3 避免誤導

  1. 避免留下隱藏代碼本意的線索;
  2. 提防使用不同之處較小的名稱;
  3. 以同樣的方式書寫同樣的概念才是信息;

2.4 做有意義的區(qū)分

  1. 在變量后面添加數(shù)字來做區(qū)分和說廢話沒有任何區(qū)別;
  2. 廢話永遠都是冗余,Variable一詞永遠不應當出現(xiàn)在變量中,而Table一詞永遠不要出現(xiàn)表名中;
  3. 要區(qū)別名稱,就要以讀者能鑒別不同之處的方式來做區(qū)分;

2.5 使用讀得出來的名稱

2.6 使用搜索得出來的名稱

  1. 單字母名稱僅用于短方法中的本地變量。
  2. 名稱長短應與其作用域大小相對應。
  3. 若變量或常量可能在代碼多處使用,則應賦其以便于搜索得名稱。

2.7 避免使用編碼

  1. 將類型和作用域帶進名稱里面,增加了解碼的負擔;
  2. 匈牙利標記法,成員前綴或后綴,接口和實現(xiàn);

2.8 避免思維映射

  1. 不應讓讀者把你的名稱翻譯為他們腦中熟知的名稱;
  2. 專業(yè)程序員了解,明確才是王道;

2.9 類名

說明:類名和對象名應該是名詞或者名詞短語,避免使用Manager、Data、Info這樣的名稱,不使用動詞。

2.10 方法名

說明:方法名使用動詞或動詞短語,重載構造器時,使用帶參數(shù)的靜態(tài)工廠方法名。

2.11 別扮可愛

2.12 每個概念對應一個詞

說明:給每個抽象概念選一個詞,并一以貫之,明確對概念的一致認識有助于迅速找到正確的名稱。

2.13 避免使用雙關語

  1. 避免將同一單詞用于不同目的;
  2. 代碼作者應盡量寫出易于理解的單詞

2.14 使用解決方案領域名稱

說明:多使用專業(yè)的術語,因為畢竟只有程序員才會看你的代碼,給某些事取一個技術性的名字,是最靠譜的做法。

2.15 使用源自問題領域的名稱

說明:優(yōu)秀的程序員和設計師,其工作之一就是分離解決方案領域和問題領域的問題。

2.16 添加有意義的語境

  1. 你需要有良好的類、函數(shù)或名稱空間來放置名稱,為讀者提供上下文的語法;
  2. 算法能夠通過分解為更小的函數(shù)使語境增強,從而顯得干凈利落;

2.17 不要添加沒有必要的語境

說明:只要短名稱足夠清楚,就要比長名稱好,別給名稱添加不必要的語境。

2.18 最后的話

說明:取好名字最難的地方在于需要良好的描述技巧和工友的文化背景。

最后編輯于
?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

相關閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容