如何通過對比優秀的代碼VS糟糕的代碼來寫出好代碼

前言

有幾天沒有更新文章，不知道各位看官的學習的勁頭還在嗎，小編是經歷了停電危機，很多小夥伴肯定在等著我更新吶，所以今天一來電趕緊來更新文章，想到還沒有帶大家了解過過編程風格，今天就在下文的對比中找到自己的編程格式，寫出優秀的好代碼。

正文

可持續開發不僅在於項目架構設計，還與代碼質量密切相關，代碼的整潔度和質量成正比。—— Robert C. Martin, 「Clean Code」

如果你還沒有發現代碼質量的區別，如果你從未見過優秀的代碼，或者從未見過糟糕的代碼，那麼本文將以直觀地對比，告訴你代碼質量究竟會有多大的區別。

[ 代碼量 ]

我們知道代碼量顯示著功能的複雜程度，例如Windows XP的代碼量超過2000萬行，Linux內核有1500萬行（2012年）。然而代碼量和功能數量之間並非線性關係。

優秀的設計中，代碼量和功能數的關係是這樣的：

糟糕的設計中，代碼量和功能數的關係是這樣的：

優秀的系統往往會有優秀的結構設計：層次清晰、職責單一、模塊化，方便擴展或者復用。功能的添加往往只是在現有框架中添加少量代碼。

然而糟糕的設計中，層次混亂、互相耦合、難以閱讀，既難以復用又不易擴展。每當被要求添加功能時，不得不幾乎完整地實現整個功能的流程，並修復與原系統的所有兼容問題。

[ 注釋]

優秀的代碼中，注釋是這樣的：

糟糕的代碼中，注釋是這樣的：

最愚蠢的程序員都能寫出機器能讀懂的代碼，而優秀的程序員能寫出人可以讀懂的代碼。

程序的注釋是為了讓人讀得懂。多數優秀的代碼中，注釋幾乎接近代碼行數的一半，描述函數功能、解釋參數配置、指出陷阱所在。而糟糕的代碼中不僅不含這些注釋，甚至會保留大量殘餘代碼，可讀性差又難以重構。

[ 命名]

優秀的代碼中，命名是這樣的：

糟糕的代碼中，命名是這樣的：

命名是為了讓代碼更加容易閱讀，使用規範的術語不僅更加易懂，同時也是開發者知識水平和開發經驗的表現。如果說以中文拼音命名顯得奇怪，那麼直接以a, b, c, d命名的便會顯得可恨，誰記得你的a是神馬東西！

看一個經典的例子，字元串替換：

稍微有點Javascript常識的便會想到正則表達式：

何必拷貝這一堆的代碼給老闆看呢？開發中確實有很多時候，直接拷貝代碼既能立竿見影地完成功能，又不會影響原有功能。但這樣的代碼多起來之後，萬一功能調整你便需要重新debug所有的副本。花一些時間學習更優雅的用法是值得的。

[ 函數 ]

保持函數的短小，使你的代碼更加易讀，例如：

將複雜的邏輯分步驟完成。如果寫在一起將會是這樣的：

相信我，一旦你寫了這樣的函數，它會隨著時間的推移變得越來越長，直到有一天，你也忘了其中的一段代碼到底是做什麼的。

事實上，複雜的函數不僅可以按照步驟劃分，更應按照層次來細化。不要在一個函數中進行不同層次的操作，否則它會變得非常難懂。

結尾

看了上面的介紹想必大家會有所收穫，擴散就是對小編最大的支持~

如果感覺文章有所收穫那就對小編的這篇文章點贊，轉發支持

歡迎關注公眾號挑戰演算法與程序設計