0. 值得清理么？

第一件你需要問(wèn)問(wèn)自己的事情就是代碼值得清理么。我不是說(shuō)當(dāng)問(wèn)到是否要清理代碼時(shí)，你一定要回答是或者一定回答不是。是你對(duì)代碼負(fù)有責(zé)任，也是你需要一直面對(duì)它們直到最終寫(xiě)出的代碼是你樂(lè)意維護(hù)的，也是你很自豪的放入代碼庫(kù)的。

如果你覺(jué)得就算代碼看起來(lái)很可怕，也不值得浪費(fèi)你本來(lái)就很緊張的時(shí)間來(lái)修復(fù)它們。所以你僅僅做了最最微小的調(diào)整解救燃眉之急。

換句話說(shuō)，你也可以將代碼看作自己的，也可以看作是別人的。

兩種情況都有優(yōu)缺點(diǎn)。優(yōu)秀的程序員看到爛代碼時(shí)會(huì)覺(jué)得很難受。他們會(huì)拿出火把和叉子并且高呼：“太亂了，太亂了”。這是一種優(yōu)秀的品質(zhì)。

但是清理代碼是一個(gè)繁雜的工作。很容易就低估了時(shí)間。甚至有時(shí)候和從頭開(kāi)始寫(xiě)代碼一樣的耗時(shí)。并且短期并沒(méi)有帶來(lái)任何的短期效應(yīng)。兩個(gè)星期的時(shí)間清理代碼并不會(huì)帶來(lái)任何新的功能，但有可能引入一些新的錯(cuò)誤。

另一方面，如果長(zhǎng)時(shí)間不清理代碼可能會(huì)帶來(lái)災(zāi)難性的毀滅?；靵y是代碼的殺手。

所以，這并不是一個(gè)容易做出的決定。需要考慮一些事情：

● 你期望對(duì)這段代碼做多少改變？你是希望僅僅修改這個(gè)小錯(cuò)誤呢，還是這段代碼還要使用多次，所以你希望將它“調(diào)教”的好些，并且加上新的功能。如果僅僅是修復(fù)一個(gè)錯(cuò)誤，那么最好是別打草驚蛇。然而，如果這個(gè)模塊你需要長(zhǎng)期折騰的話，那么現(xiàn)在開(kāi)始花點(diǎn)時(shí)間來(lái)清理它吧，之后會(huì)省掉很多煩惱。

● 你需要或者是你想引入上游的更新嗎？它是一個(gè)正在開(kāi)發(fā)當(dāng)中的開(kāi)源項(xiàng)目嗎？如果是的話，并且你想做改變的是上游的代碼，那么你不能對(duì)代碼有大的改動(dòng)否則當(dāng)你每次pull代碼的時(shí)候都會(huì)經(jīng)歷一場(chǎng)merge的噩夢(mèng)。所以你需要做一個(gè)友好的團(tuán)隊(duì)合作者，接受這個(gè)錯(cuò)誤，將帶有你修正的代碼補(bǔ)丁發(fā)給代碼的維護(hù)者。

● 要做多少工作？你一天內(nèi)實(shí)際上能清理多少行代碼？我們估計(jì)多于100行，少于1000行，好，我們假設(shè)是1000行。所以如果一個(gè)模塊有30,000行代碼的話，你可能需要一個(gè)月的時(shí)間。你有那么多時(shí)間嗎?值得這么做么？

● 它是你核心的功能嗎？如果這個(gè)模塊只是邊緣的模塊，譬如字體渲染或者圖像渲染，你可能并不在意它是否是亂七八糟的。你可能全盤(pán)不要，將來(lái)用另外的東西來(lái)代替，誰(shuí)知道呢。如果這段代碼關(guān)乎核心的性能，你需要慎重對(duì)待。

● 這段代碼有多糟糕？如果代碼僅僅有一點(diǎn)點(diǎn)糟糕，那么可能你還是可以忍受的。如果它是不可理喻的，令人崩潰的話，那么我們就必須對(duì)它下手了。

1. 建立測(cè)試用例

要認(rèn)真清理一段代碼意味著花一段時(shí)間來(lái)徹底清理它。你可能會(huì)毀壞它們。

如果你有一個(gè)比較好的測(cè)試用例，有一定的覆蓋率，你將會(huì)很容易知道什么已經(jīng)損壞了，并且你能夠很快的知道你犯了什么愚蠢的錯(cuò)誤。想要節(jié)省建立測(cè)試用例的時(shí)間在整個(gè)的清理代碼的過(guò)程中是可笑的。建立測(cè)試用例吧。這是你第一件需要做的事情。

單元測(cè)試是最好的，但是所有的代碼并不適應(yīng)單元測(cè)試。如果單元測(cè)試過(guò)于繁瑣，就換用集成測(cè)試吧。譬如，一個(gè)游戲關(guān)卡中需要一個(gè)人物完成一系列的動(dòng)作和你清理的代碼有關(guān)。

這樣的測(cè)試更加耗時(shí)，所以不可能在每一次更改之后都測(cè)試一次，雖然這是最理想的情況。因?yàn)槟銓⒚恳淮胃淖兌挤诺搅税姹究刂葡到y(tǒng)中，所以情況還不是那么糟糕。所以每一段時(shí)間（比如，五個(gè)更改）就測(cè)試一次。當(dāng)你發(fā)現(xiàn)了一個(gè)問(wèn)題時(shí)，你可以通過(guò)二進(jìn)制搜尋最近的幾次commit中找到什么地方導(dǎo)致了問(wèn)題的發(fā)生。

如果你發(fā)現(xiàn)了測(cè)試沒(méi)有發(fā)現(xiàn)的問(wèn)題，確保將這個(gè)也加入到測(cè)試中，以便將來(lái)可以測(cè)試它。

2. 使用代碼版本控制系統(tǒng)

還有人需要被告知要使用代碼版本控制系統(tǒng)嗎？我希望沒(méi)有。

清理工作是很關(guān)鍵的。你可能要做很多很多小的修改。如果什么地方出錯(cuò)了，你想回顧版本歷史，你可能找到它錯(cuò)在哪。

如果你和我一樣，你可能有時(shí)重構(gòu)（清理愚蠢的類(lèi)）的時(shí)候會(huì)出錯(cuò)，并且后來(lái)意識(shí)到這并不是個(gè)好的點(diǎn)子，或者這是個(gè)好點(diǎn)子，但是如果先做了什么之后所有的一切會(huì)變得更簡(jiǎn)單。所以你想快速的恢復(fù)一切到原狀并且重新開(kāi)始。

你的公司應(yīng)該已經(jīng)有代碼控制系統(tǒng)了，你可以在不同的分支進(jìn)行修改，在不打擾別人的情況下隨意的commit。

就算情況不是這樣的，你也應(yīng)該使用版本控制。下載Mercurial(或Git)，創(chuàng)建新的倉(cāng)庫(kù)，將代碼從你們公司的愚蠢的系統(tǒng)中簽出并放在這里。在庫(kù)中commit你的更改。當(dāng)你完成了之后你可以將所有的一切merge到那愚蠢的系統(tǒng)中。

拷貝庫(kù)到一個(gè)代碼控制系統(tǒng)中僅僅需要幾分鐘。很值得這么做。如果你不懂Mercurial，花一個(gè)小時(shí)學(xué)習(xí)它。你會(huì)為你這么做感到高興的。如果你愿意的話，花30個(gè)小時(shí)學(xué)習(xí)下Git(我是開(kāi)玩笑的！并不用這么久?，F(xiàn)在是“nerd”戰(zhàn)斗的時(shí)候了！)

3. 每次僅僅做一個(gè)小小的改動(dòng)

有兩種方法改進(jìn)壞的代碼：革命和改革。革命是用火把一切都燒掉，從新寫(xiě)一遍。改革是在不破壞的基礎(chǔ)上每次只進(jìn)行一點(diǎn)小小的改變。

這篇文章是關(guān)于改革的方法。我不是說(shuō)革命的方法從來(lái)不是必要的。有時(shí)代碼太糟糕了，需要用革命的方法。但是那些覺(jué)得改革的進(jìn)度太慢的人們往往會(huì)鼓勵(lì)改革，然而經(jīng)常沒(méi)有意識(shí)到問(wèn)題的復(fù)雜性，并最終并沒(méi)有比現(xiàn)存的系統(tǒng)更好。

Joel Spolsky寫(xiě)過(guò)一篇經(jīng)典的文章，他沒(méi)有掉入到這個(gè)緊張的爭(zhēng)論的陷阱中。

改革的最好的方法就是一次只做一個(gè)小的改變，測(cè)試它，并且commit它。當(dāng)一個(gè)改變很小時(shí)，它更容易理解改動(dòng)的后果以及確保改動(dòng)不會(huì)影響現(xiàn)有的功能。如果什么地方出錯(cuò)了，你僅僅需要核查很少的一部分代碼。

如果你開(kāi)始做更改并且意識(shí)到改得很糟糕，那么你恢復(fù)到上一次的commit，不會(huì)損失太多的無(wú)用功。如果你過(guò)了一段時(shí)間才發(fā)現(xiàn)什么地方有細(xì)微的差錯(cuò)，你可以在版本歷史中使用二進(jìn)制搜找到導(dǎo)致問(wèn)題的更改。

最常見(jiàn)的錯(cuò)誤就是一次進(jìn)行多處更改。譬如，當(dāng)去除不必要的類(lèi)層次的勢(shì)后，你發(fā)現(xiàn)API的方法并不是像你喜歡的使用方法，而你打算重新組織它們。不要這么做！先去除層次結(jié)構(gòu)，commit之后再更改API。

聰明的程序員懂得組織，所以他們也不需要太聰明。

試著找一個(gè)途徑，沿著這個(gè)途徑你可以把代碼變成你想要的模樣，每次只有一點(diǎn)點(diǎn)改動(dòng)。譬如，第一步你重命名方法，使之名字更合理。下一步，你可以將成員變量變成方法的參數(shù)。然后將算法變得更清楚些，等等。

如果你開(kāi)始做更改，并且發(fā)現(xiàn)比你原先設(shè)想的改變要大，不要害怕又退回去，使用更小的更簡(jiǎn)單的步驟去完成同樣的事情.。

4. 不要同時(shí)清理代碼和修正代碼

這是(3)的結(jié)果，但是仍然很重要。

這是一個(gè)常見(jiàn)的問(wèn)題。你開(kāi)始察看一個(gè)模塊，是因?yàn)槟阆爰尤肽硞€(gè)新功能。然后你發(fā)現(xiàn)這個(gè)代碼相當(dāng)?shù)脑愀?，所以你開(kāi)始重新組織它并且加入新的功能。

問(wèn)題在于清理代碼和修正錯(cuò)誤是完全不同的目標(biāo)。當(dāng)你清理的勢(shì)后，你想讓代碼看起來(lái)更好，而沒(méi)有改變它的功能。當(dāng)你修正錯(cuò)誤時(shí)， 你想改變功能。如果你同時(shí)清理代碼和改正錯(cuò)誤，很難保證清理不會(huì)改變什么。

先清理代碼，然后再在一個(gè)干凈的基礎(chǔ)上，加入新的功能。

1. 刪除你沒(méi)有使用的功能

清理的時(shí)間正比于代碼的數(shù)量，復(fù)雜性和糟糕的程度。

如果代碼的功能你目前沒(méi)有使用，而且在可預(yù)見(jiàn)的將來(lái)也不會(huì)使用，那么就刪除它，這會(huì)減少你瀏覽的代碼數(shù)，降低復(fù)雜度（刪除不必要的概念和依賴(lài)）。你會(huì)清理的更快的，而且最后的結(jié)果會(huì)更簡(jiǎn)單。

不要留著代碼僅僅因?yàn)?ldquo;誰(shuí)知道呢，你可能某一天需要它”。代碼是有代價(jià)的 – 它需要被移植，修正錯(cuò)誤，被閱讀以及被理解。你有更少的代碼，就更好。就算在最不可能的情況下，你需要這個(gè)舊代碼，你也能從代碼庫(kù)中找到它。

6. 刪除大部分的注釋

爛代碼很少會(huì)有好的注釋。它們通常是這樣的：

// Pointless: 
 
    // Set x to 3 
 
    x = 3; 
 
// Incomprehensible: 
 
    // Fix for CB (aug) 
 
    pos += vector3(0, -0.007, 0); 
 
// Sowing fear and doubt: 
 
    // Really we shouldn't be doing this 
 
    t = get_latest_time(); 
 
// Downright lying: 
 
    // p cannot be NULL here 
 
    p->set_speed(0.7);