代碼整潔之道

1、即便是在宏偉的建筑作品中，我們也聽(tīng)到關(guān)注細(xì)節(jié)的回響。認(rèn)真對(duì)待每個(gè)變量名，你當(dāng)用為自己第一個(gè)孩子命名般的謹(jǐn)慎來(lái)給變量命名。全新傾注于細(xì)節(jié)，屢見(jiàn)于追求卓越的行為之中。小處要誠(chéng)實(shí)。是否已盡力“把露營(yíng)地清理得比來(lái)時(shí)還干凈”？簽入代碼前是否已做重構(gòu)？是的，我們就是一群代碼猴子，上躥下跳，自以為領(lǐng)略了編程的真諦?？上В?dāng)我們抓著幾個(gè)酸桃子，得意洋洋坐到樹(shù)枝上，卻對(duì)自己造成的混論熟視無(wú)睹。那堆“可以運(yùn)行”的亂麻程序，就在我們眼皮底下慢慢腐壞。稍后等于

2、永不（Laterequalsnever）。制造混亂無(wú)助于趕上期限?；靵y只會(huì)立刻拖慢你，叫你錯(cuò)過(guò)期限。趕上期限的唯一方法——做得快的唯一方法——就是始終可能保持代碼整潔。整潔的代碼只做一件事。代碼應(yīng)當(dāng)講述事實(shí)，不引人猜測(cè)。如果每個(gè)例程都讓你感到深合己意，那就是整潔代碼。如果代碼讓編程語(yǔ)言看起來(lái)像是專(zhuān)門(mén)為解決那個(gè)問(wèn)題而存在，就可以稱(chēng)之為漂亮的代碼。有意義的命名：有意義的命名：變量、函數(shù)或類(lèi)的名稱(chēng)應(yīng)該告訴你，它為什么會(huì)存在，它做什么事，應(yīng)該怎

3、么用。如果名稱(chēng)需要注釋來(lái)補(bǔ)充，那就不算是名副其實(shí)。程序員必須避免留下掩藏代碼本意的錯(cuò)誤線索，應(yīng)當(dāng)避免使用與本意相悖的詞。以同樣的方式拼寫(xiě)出同樣的概念才是信息，拼寫(xiě)前后不一致就是誤導(dǎo)。要區(qū)分名稱(chēng)，就要以讀者能鑒別不同之處的方式來(lái)區(qū)分。使用可搜索的名稱(chēng)：長(zhǎng)名稱(chēng)勝于短名稱(chēng)，搜得到的名稱(chēng)勝于用自造編碼寫(xiě)就的名稱(chēng)，名稱(chēng)長(zhǎng)短應(yīng)與其作用域大小相對(duì)應(yīng)。不必用前綴來(lái)標(biāo)明成員變量。專(zhuān)業(yè)的程序員了解，明確是王道，專(zhuān)業(yè)程序員善用其能，編寫(xiě)其他人能理解的代碼。類(lèi)

4、名和對(duì)象名應(yīng)該是名詞或名詞短語(yǔ)。方法名應(yīng)當(dāng)是動(dòng)詞或動(dòng)詞短語(yǔ)。函數(shù)名稱(chēng)應(yīng)當(dāng)獨(dú)一無(wú)二，而且要保持一致，即同樣的目的以同樣的命名稱(chēng)呼。別用雙關(guān)語(yǔ)，即不要同一術(shù)語(yǔ)用于不同概念。使用異常替代返回錯(cuò)誤碼，當(dāng)返回錯(cuò)誤碼時(shí)，就是在要求調(diào)用者立刻處理錯(cuò)誤。最好把try和catch代碼塊的主題部分抽離出來(lái)，另外形成函數(shù)。使用異常替代錯(cuò)誤碼，新異常就可以從異常類(lèi)派生出來(lái)。注釋?zhuān)鹤⑨專(zhuān)喝绻惆l(fā)現(xiàn)自己需要寫(xiě)注釋?zhuān)傧胂肟词欠衲苡么a來(lái)表達(dá)。注釋存在的時(shí)間越久，就

5、離其所描述的代碼越遠(yuǎn)，越來(lái)越變得全然錯(cuò)誤。原因很簡(jiǎn)單那，程序員不能堅(jiān)持維護(hù)注釋。代碼在變動(dòng)，在演化。從這里移到哪里。彼此分離、重造又合到一起。注釋并不總是隨之變動(dòng)。注釋常常會(huì)與其所描述的代碼分隔開(kāi)來(lái)，孑然飄零，越來(lái)越不準(zhǔn)確。真實(shí)只在一處地方：代碼。只有代碼能忠實(shí)地告訴你它做的事。那是唯一真正準(zhǔn)確的信息來(lái)源。所以，盡管有時(shí)也需要注釋?zhuān)覀円苍摱嗷ㄐ乃急M量減少注釋量。注釋不能美化糟糕的代碼，如果代碼爛不是應(yīng)當(dāng)寫(xiě)注釋而是把代碼搞干凈。帶有少量

6、注釋的整潔而有表達(dá)力的代碼，要比帶有大量注釋的零碎的而復(fù)雜的代碼像樣得多。能用函數(shù)或變量時(shí)就別用注釋。注釋的作用是解釋未能自行解釋的代碼。短函數(shù)不需要太多描述。為只做一件事的短函數(shù)選個(gè)好名字，通常要比寫(xiě)函數(shù)頭注釋要好。關(guān)系密切的概念應(yīng)該互相靠近。一般而言，我們想自上向下展示函數(shù)條用依賴(lài)順序，被調(diào)用的函數(shù)應(yīng)該放在執(zhí)行調(diào)用的函數(shù)下面。像報(bào)紙文章一般，我們指望最重要的概念先出來(lái)，指望以包括最少細(xì)節(jié)的方式表述它們。我們指望底層細(xì)節(jié)最后出來(lái)，這樣