介紹了五個(gè)簡(jiǎn)單的總體概念 可輕松寫(xiě)出寫(xiě)出好代碼

Bug 少，性能好，容易修改。好的代碼影響深遠(yuǎn)，而且它可能是產(chǎn)生10 倍工作效率的開(kāi)發(fā)者的主要原因。盡管好代碼十分重要，但開(kāi)發(fā)新手卻不得要領(lǐng)。關(guān)于這一主題的技巧多而冗雜，讓新手們?nèi)绾斡浀米?？“Code Complete(《代碼大全》)” 是這個(gè)主題的經(jīng)典，但內(nèi)容多達(dá) 960 頁(yè)！

我認(rèn)為應(yīng)該建立起良好的心態(tài)，這樣，不管你用什么語(yǔ)言或者庫(kù)，都會(huì)自然而然的寫(xiě)出高質(zhì)量的代碼。這里我主要談到 5 個(gè)相關(guān)的概念。記住它們，輕松寫(xiě)出寫(xiě)出好代碼。

請(qǐng)避免特立獨(dú)行

當(dāng)你讀到一些文章中的新技巧時(shí)，如醍醐灌頂，一定會(huì)想要寫(xiě)點(diǎn)看起來(lái)很聰明的代碼，讓同行們眼前一亮。

問(wèn)題是人們只是想修完 BUG，然后繼續(xù)處理其它事情。那些聰明的技巧常常只會(huì)成為一種消遣。我曾經(jīng)在“將神經(jīng)科學(xué)應(yīng)用于軟件開(kāi)發(fā)”中談到，當(dāng)人們被迫花心思來(lái)理解你的某段代碼時(shí)，它們的“精神堆棧”會(huì)迅速填滿，因而難以理解其中深意。

[譯者注：圖片中的注釋內(nèi)容：這在 C 語(yǔ)言中用于避免誤寫(xiě)成 variable = null。最近它造成不少人困惑，但似乎并沒(méi)帶來(lái)多大好處]

不要在工作中使用太多可能需要額外解釋的個(gè)性化方式。

不要用“你的方式”來(lái)編寫(xiě)代碼，只需要按照標(biāo)準(zhǔn)（的代碼規(guī)范）來(lái)編寫(xiě)就好。再次強(qiáng)調(diào)，要寫(xiě)讓人讀得明白，看得下去的代碼，讓人家能夠理解它。

分而治之

模塊化可以使復(fù)雜的代碼結(jié)構(gòu)變得清晰，除此之外還有很多方法可以達(dá)到同樣的目的，而無(wú)需創(chuàng)建更多函數(shù)。將長(zhǎng)長(zhǎng)的條件表達(dá)式保存為一到兩個(gè)變量就是個(gè)不錯(cuò)的方法，可以避免調(diào)用函數(shù)的開(kāi)銷(xiāo)。這些變量可以用在其它地方，甚至可用于組合更復(fù)雜的條件。

拆解問(wèn)題的方法在于盡可能的讓每個(gè)部分保持集中，只影響局部狀態(tài)，不要混入不相關(guān)的問(wèn)題，要避免副作用。編程語(yǔ)言和庫(kù)通常會(huì)帶來(lái)各自相應(yīng)的問(wèn)題，避免這些問(wèn)題可以讓你的代碼更專(zhuān)注于其表達(dá)的業(yè)務(wù)。單一責(zé)任原則就是通過(guò)集中代碼和局部化代碼帶來(lái)良好設(shè)計(jì)的例子。

[譯者注：圖中注釋內(nèi)容：這是不需要額外函數(shù)開(kāi)銷(xiāo)的一種模塊化方法]

我喜歡利用變量來(lái)進(jìn)行邏輯劃分。

TDD（Test Driven Development，測(cè)試驅(qū)動(dòng)開(kāi)發(fā)）的成功實(shí)施表現(xiàn)出了它所帶來(lái)的好處，它迫使人們運(yùn)用一些以前不受歡迎的準(zhǔn)則。無(wú)狀態(tài)的代碼曾經(jīng)被嫌棄又慢又沒(méi)必要（大部分老的 C/C++ 代碼中可以看到），然而現(xiàn)在每個(gè)人都在談?wù)摷兒瘮?shù)。就算你不采用 TDD，你也應(yīng)該學(xué)習(xí)它背后的原則。在新的模式下工作會(huì)讓你成為適應(yīng)性極強(qiáng)的開(kāi)發(fā)者。

分離代碼并使其可分別處理

你寫(xiě)代碼的時(shí)候面臨著什么樣的困難，你的計(jì)算機(jī)和工具也面臨著同樣的困難。代碼的復(fù)雜性，與需要進(jìn)行的預(yù)處理和需要處理的突發(fā)情況存在著或多或少的聯(lián)系。

現(xiàn)在暫時(shí)拋開(kāi)那些額外的構(gòu)建工具所帶來(lái)的好處。它們需要你使用特定領(lǐng)域的語(yǔ)言，比如自定義模板，或者復(fù)雜的動(dòng)態(tài)數(shù)據(jù)結(jié)構(gòu)，比如哈稀表。IDE 通常不善于處理這些東西，要找到相關(guān)的代碼段則更加困難。

盡量避免使用不能很好支持 IDE 的語(yǔ)言擴(kuò)展和庫(kù)。它們給你的生產(chǎn)力帶來(lái)的好處，遠(yuǎn)大于簡(jiǎn)易配置和用簡(jiǎn)潔語(yǔ)法保存擊鍵帶來(lái)的小便利。

[譯者注：圖中注釋內(nèi)容：使用神奇的字體串可能造成 IDE 不能正確識(shí)別你的代碼]

ServiceLocator 是與 IDE 整合不佳的一個(gè)設(shè)計(jì)樣例。

另一個(gè)保持 IDE“整合度”的相關(guān)方法是避免編寫(xiě)特殊的代碼。多數(shù)語(yǔ)言都提供了編寫(xiě)動(dòng)態(tài)代碼的能力。如果濫用這些特性，比如特殊的字符串、特殊的數(shù)組索引和自定義模板語(yǔ)言特性等，會(huì)產(chǎn)生難以連接的代碼庫(kù)[譯者注：這里的連接應(yīng)該是指相互關(guān)聯(lián)的關(guān)系，連接最直接的影響是在使用 IDE 等工具進(jìn)行重構(gòu)的時(shí)候可以自動(dòng)根據(jù)連接關(guān)系修改相關(guān)引用]。一般說(shuō)來(lái)，那些只有你一個(gè)人才能看懂的特性會(huì)讓你摔跟頭的，因?yàn)槿绻?IDE 不能理解這些代碼，在你想進(jìn)行結(jié)構(gòu)調(diào)整的時(shí)候，IDE 就沒(méi)法幫你進(jìn)行重構(gòu)。

讓程序可讀

致力于可預(yù)測(cè)的架構(gòu)。這種架構(gòu)下你的隊(duì)友要進(jìn)行某項(xiàng)查找就會(huì)很容易，可以節(jié)約不少時(shí)間。一旦你為項(xiàng)目確定了一個(gè)整體的架構(gòu)，就一定要把主要元素放在顯眼的位置。使用 MVC？把模型、視圖和控制器放在他們自己的目錄下，不要放在三個(gè)深層次的目錄中，也不要放在幾個(gè)不同的地方。

我在前面談到了模塊化。也存在過(guò)度的模塊化，讓定位代碼這種事情變得艱難無(wú)比。IDE 可能會(huì)帶來(lái)一些幫助，但通常你往往會(huì)讓 IDE 忽略庫(kù)目錄，因?yàn)槠渲杏泻芏嗖幌嚓P(guān)的代碼，或者它的索引需要人工處理一些問(wèn)題，就會(huì)造成兩敗俱傷的局面。盡量使用較少的庫(kù)，選用那些盡可能多覆蓋你需求的庫(kù)。

庫(kù)和工具也可能成為新人的障礙。我最近使用 EcmaScript 7 (babel) 構(gòu)建了一個(gè)項(xiàng)目，后來(lái)我才意識(shí)到我們的初級(jí)開(kāi)發(fā)人員一直因?yàn)橄敫忝靼姿ㄔ谀抢铮@對(duì)團(tuán)隊(duì)的生產(chǎn)力造成了巨大損失。我低估了這對(duì)一個(gè)新手所帶來(lái)的壓力。不要使用對(duì)當(dāng)前來(lái)說(shuō)太難掌握的工具，等時(shí)機(jī)成熟再使用。

這是我寫(xiě)的一個(gè) makefile 中的真實(shí)代碼。新手不需掌握過(guò)多的新技術(shù)。

讓代碼易于理解

如果你已經(jīng)做到了這一點(diǎn)，那我們來(lái)解決更重要的問(wèn)題——選擇好名字，這是軟件開(kāi)發(fā)中的重要部分。構(gòu)建工具在這方面不能提供幫助，原因很簡(jiǎn)單，計(jì)算機(jī)不會(huì)真正知道解決方案背后的邏輯。你得通過(guò)文檔來(lái)解釋代碼，而與主題相關(guān)，且符合上下文，體現(xiàn)變量和功能的名稱(chēng)就能很好做到這一點(diǎn)。語(yǔ)義化的名稱(chēng)甚至可以減少對(duì)文檔的需求。

在名稱(chēng)中使用前綴對(duì)理解它們很有幫助。這在過(guò)去是一種流行的做法，我認(rèn)為對(duì)這種作法的誤用導(dǎo)致了它的消亡。像匈牙利命名法這樣的前綴系統(tǒng)最初只是為了增加意義，但最后用于其中的上下文越來(lái)越少，終于少得只剩類(lèi)型信息。

[譯者注：圖中的注釋內(nèi)容：使用名稱(chēng)來(lái)表達(dá)意圖，不要利用語(yǔ)言來(lái)耍小聰明]

近來(lái)，F(xiàn)luent 接口經(jīng)常被濫用。

最后要說(shuō)說(shuō)老生常談的回溯復(fù)雜度。簡(jiǎn)單地說(shuō)就是要盡可能減少條件分支的數(shù)目。每多一個(gè)分支都會(huì)增加縮進(jìn)，同時(shí)降低可讀性。不過(guò)更重要的是，增加的東西越多，你需要跟蹤的東西就越多。

結(jié)論

本文介紹了五個(gè)簡(jiǎn)單的總體概念，我希望你能從中輕松的學(xué)習(xí)到組織代碼的方法。

實(shí)踐是最好的老師，用編程來(lái)鞏固理論。如果你還沒(méi)有這樣做，我誠(chéng)摯向你推薦代碼大全。它帶來(lái)了大量的示例，幾乎剖析了你可能遇到的每一種問(wèn)題。