[轉]寫好代碼的10個秘密 收藏

作者：飛哥 （百度）

先給大家看一段據說是史上最強的程序：
e100 33 f6 bf 0 20 b5 10 f3 a5 8c c8 5 0 2 50 68 13 1 cb e 1f be a1 1 bf 0 1
e11b 6 57 b8 11 1 bb 21 13 89 7 4b 4b 48 79 f9 ad 86 e0 8b c8 bd ff ff e8 20
e134 0 3d 0 1 74 1a 7f 3 aa eb f3 2d ff 0 50 e8 f 0 5a f7 d8 8b d8 26 8a 1 aa
e14f 4a 75 f9 eb de cb 57 bb 21 13 8b c1 40 f7 27 f7 f5 8b fb ba 11 1 4f 4f 4a
e168 39 5 7f f9 52 8b c5 f7 25 f7 37 2b c8 95 f7 65 2 f7 37 95 2b e8 fe e fe
e181 10 79 6 c6 6 fe 10 7 46 d0 14 d1 d1 d1 e5 79 ec 5a b8 11 1 ff 7 4b 4b 48
e19b 3b d0 75 f7 5f c3 83 f7 83 a6 5d 59 82 cd b2 8 42 46 9 57 a9 c5 ca aa 1b
.............................................................................


這段程序是1997年世界程序設計大賽的一等獎作品的部分代碼（完整的代碼下載，把代碼復制粘貼到cmd的debug命令中，回車看到效果）。這個程序運行后將是一個3D的且伴隨著音樂的動畫。震撼吧！
是不是從事軟件開發的人員都希望成為這樣的武林高手呢？然而真要是用這樣的高手來設計、編寫我們的產品代碼，恐怕某一天，我們什么都不用干了，只能人手一本機器代碼，一句一句進行翻譯了；那么對于軟件產品開發而言，如何寫好代碼呢？一流的軟件產品的代碼具備哪些特征呢？

一流代碼的特征

1、穩定可靠（Robustness）
代碼寫出來以后，一定要能夠運行得非常好，非常穩定可靠。在現 今的IT行業，軟件產品都是是24*7，即要保證系統一天24小時，一星期7天中都可以無間斷的正常運行。比如我們百度的搜索引擎系統，比如我們的通信系 統，等等。到了產品開發后期，大部分的成本都將投入到產品穩定性的提高。

2、可維護且簡潔（Maintainable and Simple Code）
在寫代碼時，首先要考 慮的是：寫出來的代碼不但要自己可以讀懂，而且我們的同事、測試工程師都可能要修改這些代碼，對其進行增減。如果代碼很復雜，不容易讀懂，如程序中的遞歸 一大堆、程序不知何時或從何地跳出，則會使程序的可維護性和簡潔性降低。所以必要的注釋、統一的編程規范等都是非常重要的。

3、高效（Fast）
在軟件行業中效率是非常重要的，比如搜索引擎。有些軟件的搜索效率就不高，搜索過 程特別緩慢，讓人難以接受。當然這里面有一個帶寬的問題，但是程序效率不高也是一個重要的原因。而實際上程序的效率提高，有時候很簡單，并沒有什么神秘之 處，如使用數組索引時候，可以用指針方式而不使用數組下標；數組的空間定義應該定義為2的N次冪等等。

4、簡短（Small）
這方面大家的感受可能不是很深，但是我的感受是很深的。配置過PSTN程控交換 機、路由器、VoIP網關設備的人都知道，這些設備的軟件都是從PC機通過網口或串口下載到這些設備的Flash上（類似PC機的BIOS）再通過設備上 的CPU啟動。如果程序寫的很羅嗦，隨著特性不斷增加，程序規模將變大的巨大，Flash空間告急、內存告急、下載升級變的不可忍受，等等，帶來的就是成 本不斷增加，利潤不斷下降。

5、共享性（Reusable）
如果做大型產品開發，程序的共享性也是非常重要的。我們產品有那么多開 發人員，如果每一個人都自己定義字符串、鏈表等數據結構，那么開發效率就會降低，我們的產品恐怕到今天也不能出臺。我所說的“共享”不是指將別人的代碼復 制到自己的代碼中，而是指直接調用別人的代碼，拿來即可用。這一方面可以減少代碼的冗余性，另一方面可以增強代碼的可維護性。如果別人的代碼里有Bug， 只需修改他的代碼，而調用此代碼的程序不用進行任何修改就可以達到同步。這同時要求我們在設計的時候，如何考慮系統的內聚和耦合的問題。

6、可測試性（Testable）
我們的產品開發里，除了軟件開發人員，還有一部分工程師負責軟件測 試。軟件測試人員會將開發代碼拿來，一行一行地運行，看程序運行是否有錯。如果軟件開發人員的代碼不可測試，那測試工程師就沒有辦法進行工作。因此可測試 性在大型軟件開發里是很重要的一點。可測試性有時候與可維護性是遙相呼應的，一個具有好的可測試性和可維護性的代碼，測試人員可以根據開發提供的維護手 冊、debug信息手冊等就可以判斷出程序出錯在哪個模塊。

7、可移植性（Portable）
可移植性是指程序寫出來以后，不僅在windows 2000里可以運行，在NT/9X下可以運行，而且在Linux甚至Macintosh等系統下都可以運行。所有這些特性都是一流代碼所具備的特性。但是 其中有些特性是會有沖突的。比如高效性，程序寫的效率很高，就可能變得很復雜，犧牲的就是簡潔。好的代碼要在這些特性中取得平衡。

寫好代碼的10個秘密

1、百家之長歸我所有（Follow Basic Coding Style）
其實寫代碼的方式有很多，每個人都有自己的風格，但是眾多的風格中總有一些共性的、基本的寫代碼的風格，如為程序寫注釋、代碼對齊，等等。是不是編程規范？對就是編程規范。

2、取個好名字（Use Naming Conventions）
取個好的函數名、變量名，最好按照一定的規則起名。還是編程規范。

3、凌波微步，未必摔跤（Evil goto's?Maybe Not...）
這里我用“凌波微步”來形容goto語句。通常，goto語句使程序跳來跳去，不容易讀，而且不能優化，但是在某種情況下，goto語句反而可以增強程序的可讀性。Just go ahead，not go back。

4、先發制人，后發制于人（Practic Defensive Coding）
Defensive Coding指一些可能會出錯的情況，如變量的初始化等，要考慮到出現錯誤情況下的處理策略。測試時要多運行幾個線程。有些程序在一個線城下運行是正常 的，但是在多個線程并行運行時就會出現問題；而有些程序在一個CPU下運行幾個線程是正常的，但是在多個CPU下運行時就會出現問題，因為單CPU運行線 程只是狹義的并行，多CPU一起運行程序，才是真正的并行運算。

5、見招拆招，滴水不漏（Handle The Error Cases：They Will Occur！）
這里的Error Case（錯誤情況），是指那些不易重視的錯誤。如果不對Error Case進行處理，程序在多數情況下不會出錯，但是一旦出現異常，程序就會崩潰。 6、熟習劍法刀術，所向無敵（Learn Win32 API Seriously）
用“劍法刀術”來形容一些API是因為它們都是經過了很多優秀開發人員的不斷開發、測試，其效率很高，而且簡潔易懂，希望大家能掌握它，熟悉它，使用它。是不是象我們的ULIB。

7、雙手互搏，無堅不摧（Test,but don't stop there）
這里的測試不是指別人來測試你的代碼，而是指自己去測試。因為你是寫代碼的原作者，對代碼的了解最深，別人不可能比你更了解，所以你自己在測試時，可以很好地去測試哪些邊界條件，以及一些意向不到的情況。

8、活用斷言（Use,don't abuse,assertions）
斷言（assertion）是個很好的調試工具和方法，希望大家能多用斷言，但是并不是所有的情況下都可以用到斷言。有些情況使用斷言反而不合適。

9、草木皆兵，不可大意（Avoid Assumptions）
是指在寫代碼時，要小心一些輸入的情況，比如輸入文件、TCP的sockets、函數的參數等等，不要認為使用我們的API的用戶都知道什么是正確的、什么是錯的，也就是說一定要考慮到對外接口的出錯處理問題。

10、最高境界、無招勝有招（Stop writing so much code）
意思就是說盡量避免寫太多的代碼，寫的越多，出錯的機會也越多。最好能重用別人開放的接口函數或直接調用別人的api。