有意義的命名

在編程過(guò)程中,命名隨處可見(jiàn)。我們?cè)诰幊踢^(guò)程中,應(yīng)使命名名副其實(shí)。這件事很重要也很?chē)?yán)肅,選個(gè)好的名字要花很多時(shí)間,但是我們卻能省下更多的時(shí)間。而且我們一旦發(fā)現(xiàn)更好的名字就應(yīng)換掉舊的。
我們?cè)诿麜r(shí),名稱(chēng)就應(yīng)當(dāng)答復(fù)了大多數(shù)問(wèn)題。它應(yīng)該告訴你,它為什么存在,它做什么事,應(yīng)該怎么用。

  • 有意義的區(qū)分
    我們?cè)诿麜r(shí)應(yīng)依義命名。萬(wàn)萬(wàn)不能使用數(shù)字系列命名(a1,a2 ,···,aN),這樣的名稱(chēng)純屬誤導(dǎo)——完全沒(méi)有提供正確信息;沒(méi)有提供導(dǎo)向作者意圖的線(xiàn)索。
  • 使用讀得出來(lái)的名稱(chēng)
  • 使用可搜索的名稱(chēng)
  • 避免使用編碼
  • 避免思維映射
    不應(yīng)當(dāng)讓讀者把你的名稱(chēng)翻譯成他們熟知的名稱(chēng)
    -類(lèi)名
    類(lèi)名和對(duì)象名應(yīng)該是名詞或名詞短語(yǔ)
  • 方法名
    方法名應(yīng)當(dāng)是動(dòng)詞或動(dòng)詞短語(yǔ)
  • 每個(gè)概念對(duì)應(yīng)一個(gè)詞
    給每個(gè)抽象概念選一個(gè)詞,并且一以貫之。
  • 別用雙關(guān)語(yǔ)
  • 使用解決方案領(lǐng)域名稱(chēng)
    只有程序員才會(huì)讀你的代碼。所以盡管使用那些計(jì)算機(jī)科學(xué)領(lǐng)域術(shù)語(yǔ)、算法名、模式名、數(shù)學(xué)術(shù)語(yǔ)吧。
    -使用源自所涉問(wèn)題領(lǐng)域的名稱(chēng)
    如果不能用程序員熟悉的術(shù)語(yǔ)來(lái)命名就采取從所涉問(wèn)題領(lǐng)域來(lái)的名稱(chēng)。
  • 添加有意義的語(yǔ)境
    很少有名稱(chēng)是能自我說(shuō)明的。所以我們需要用良好命名的類(lèi)、函數(shù)或名名稱(chēng)空間來(lái)放置名稱(chēng),給讀者提供語(yǔ)境。如果沒(méi)有這么做,可以給名稱(chēng)添加前綴。
    注意:不要添加沒(méi)用的語(yǔ)境,比如給所有類(lèi)添加同一個(gè)前綴。只要語(yǔ)義足夠清楚,短名稱(chēng)比長(zhǎng)名稱(chēng)要好。
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,224評(píng)論 6 529
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 97,916評(píng)論 3 413
  • 文/潘曉璐 我一進(jìn)店門(mén),熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人,你說(shuō)我怎么就攤上這事。” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 175,014評(píng)論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀(guān)的道長(zhǎng)。 經(jīng)常有香客問(wèn)我,道長(zhǎng),這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 62,466評(píng)論 1 308
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 71,245評(píng)論 6 405
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 54,795評(píng)論 1 320
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,869評(píng)論 3 440
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 42,010評(píng)論 0 285
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,524評(píng)論 1 331
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 40,487評(píng)論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 42,634評(píng)論 1 366
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,173評(píng)論 5 355
  • 正文 年R本政府宣布,位于F島的核電站,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 43,884評(píng)論 3 345
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 34,282評(píng)論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 35,541評(píng)論 1 281
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 51,236評(píng)論 3 388
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 47,623評(píng)論 2 370

推薦閱讀更多精彩內(nèi)容

  • 本章,作為整潔代碼的頭一步,致力于規(guī)范命名規(guī)則。 圖片來(lái)自<Clean Code> 所謂名不正則言不順,命名的好,...
    徐朝_尼克徐閱讀 713評(píng)論 0 1
  • 名副其實(shí) 選個(gè)好名字要花時(shí)間,但省下來(lái)的時(shí)間比花掉的多。 一旦發(fā)現(xiàn)有更好的名稱(chēng),就換掉舊的。 好的名稱(chēng)會(huì)告訴你:它...
    lsh的學(xué)習(xí)筆記閱讀 220評(píng)論 0 0
  • 名副其實(shí): 變量、函數(shù)或類(lèi)的名稱(chēng)就能夠說(shuō)明為什么它存在,做什么事,怎么用,如果需要注釋來(lái)補(bǔ)充,就不算名副其實(shí): 避...
    樹(shù)下老男孩閱讀 858評(píng)論 0 3
  • 2.2 名副其實(shí) 在代碼中體現(xiàn)上下文的語(yǔ)境,能夠知道這段代碼想干什么; 2.3 避免誤導(dǎo) 避免留下隱藏代碼本意的線(xiàn)...
    coding_zero閱讀 309評(píng)論 0 0
  • 凈空法師:惡念太多相貌就不好看 佛在經(jīng)論上告訴我們,一切眾生的相,是業(yè)力變現(xiàn)的。相的好丑,就是善惡業(yè)的現(xiàn)前。俗話(huà)常...
    磬思candy閱讀 744評(píng)論 0 2