第二章 有意義的命名

2.2 名副其實

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

2.3 避免誤導

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

2.4 做有意義的區分

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

2.5 使用讀得出來的名稱

2.6 使用搜索得出來的名稱

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

2.7 避免使用編碼

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

2.8 避免思維映射

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

2.9 類名

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

2.10 方法名

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

2.11 別扮可愛

2.12 每個概念對應一個詞

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

2.13 避免使用雙關語

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

2.14 使用解決方案領域名稱

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

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

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

2.16 添加有意義的語境

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

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

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

2.18 最后的話

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

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,250評論 6 530
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 97,923評論 3 413
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,041評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,475評論 1 308
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,253評論 6 405
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,801評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,882評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,023評論 0 285
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,530評論 1 331
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,494評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,639評論 1 366
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,177評論 5 355
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,890評論 3 345
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,289評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,552評論 1 281
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,242評論 3 389
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,626評論 2 370

推薦閱讀更多精彩內容