寫好代碼的10個(gè)秘密

先給大家看一段據(jù)說是史上最強(qiáng)的程序：
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年世界程序設(shè)計(jì)大賽的一等獎(jiǎng)作品的部分代碼（完整的代碼下載http://www.tengjunxing.cn/?p=217，把代碼復(fù)制粘貼到cmd的debug命令中，回車看到效果）。這個(gè)程序運(yùn)行后將是一個(gè)3D的且伴隨著音樂的動(dòng)畫。震撼吧！

是不是從事軟件開發(fā)的人員都希望成為這樣的武林高手呢？然而真要是用這樣的高手來設(shè)計(jì)、編寫我們的產(chǎn)品代碼，恐怕某一天，我們什么都不用干了，只能人手一本機(jī)器代碼，一句一句進(jìn)行翻譯了；那么對于軟件產(chǎn)品開發(fā)而言，如何寫好代碼呢？一流的軟件產(chǎn)品的代碼具備哪些特征呢？

一流代碼的特征

1、穩(wěn)定可靠（Robustness）

代碼寫出來以后，一定要能夠運(yùn)行得非常好，非常穩(wěn)定可靠。在現(xiàn)今的IT行業(yè)，軟件產(chǎn)品都是是24*7，即要保證系統(tǒng)一天24小時(shí)，一星期7天中都可以無間斷的正常運(yùn)行。比如我們百度的搜索引擎系統(tǒng)，比如我們的通信系統(tǒng)，等等。到了產(chǎn)品開發(fā)后期，大部分的成本都將投入到產(chǎn)品穩(wěn)定性的提高。

2、可維護(hù)且簡潔（Maintainable and Simple Code）

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

3、高效（Fast）

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

4、簡短（Small）

這方面大家的感受可能不是很深，但是我的感受是很深的。配置過PSTN程控交換機(jī)、路由器、VoIP網(wǎng)關(guān)設(shè)備的人都知道，這些設(shè)備的軟件都是從PC機(jī)通過網(wǎng)口或串口下載到這些設(shè)備的Flash上（類似PC機(jī)的BIOS）再通過設(shè)備上的CPU啟動(dòng)。如果程序?qū)懙暮芰_嗦，隨著特性不斷增加，程序規(guī)模將變大的巨大，F(xiàn)lash空間告急、內(nèi)存告急、下載升級變的不可忍受，等等，帶來的就是成本不斷增加，利潤不斷下降。

5、共享性（Reusable）

如果做大型產(chǎn)品開發(fā)，程序的共享性也是非常重要的。我們產(chǎn)品有那么多開發(fā)人員，如果每一個(gè)人都自己定義字符串、鏈表等數(shù)據(jù)結(jié)構(gòu)，那么開發(fā)效率就會(huì)降低，我們的產(chǎn)品恐怕到今天也不能出臺。我所說的“共享”不是指將別人的代碼復(fù)制到自己的代碼中，而是指直接調(diào)用別人的代碼，拿來即可用。這一方面可以減少代碼的冗余性，另一方面可以增強(qiáng)代碼的可維護(hù)性。如果別人的代碼里有Bug，只需修改他的代碼，而調(diào)用此代碼的程序不用進(jìn)行任何修改就可以達(dá)到同步。這同時(shí)要求我們在設(shè)計(jì)的時(shí)候，如何考慮系統(tǒng)的內(nèi)聚和耦合的問題。

6、可測試性（Testable）

我們的產(chǎn)品開發(fā)里，除了軟件開發(fā)人員，還有一部分工程師負(fù)責(zé)軟件測試。軟件測試人員會(huì)將開發(fā)代碼拿來，一行一行地運(yùn)行，看程序運(yùn)行是否有錯(cuò)。如果軟件開發(fā)人員的代碼不可測試，那測試工程師就沒有辦法進(jìn)行工作。因此可測試性在大型軟件開發(fā)里是很重要的一點(diǎn)?？蓽y試性有時(shí)候與可維護(hù)性是遙相呼應(yīng)的，一個(gè)具有好的可測試性和可維護(hù)性的代碼，測試人員可以根據(jù)開發(fā)提供的維護(hù)手冊、debug信息手冊等就可以判斷出程序出錯(cuò)在哪個(gè)模塊。

7、可移植性（Portable）

可移植性是指程序?qū)懗鰜硪院?，不僅在windows 2000里可以運(yùn)行，在NT/9X下可以運(yùn)行，而且在Linux甚至Macintosh等系統(tǒng)下都可以運(yùn)行。所有這些特性都是一流代碼所具備的特性。但是其中有些特性是會(huì)有沖突的。比如高效性，程序?qū)懙男屎芨撸涂赡茏兊煤軓?fù)雜，犧牲的就是簡潔。好的代碼要在這些特性中取得平衡。

寫好代碼的10個(gè)秘密

1、百家之長歸我所有（Follow Basic Coding Style）

其實(shí)寫代碼的方式有很多，每個(gè)人都有自己的風(fēng)格，但是眾多的風(fēng)格中總有一些共性的、基本的寫代碼的風(fēng)格，如為程序?qū)懽⑨?、代碼對齊，等等。是不是編程規(guī)范？對就是編程規(guī)范。

2、取個(gè)好名字（Use Naming Conventions）

取個(gè)好的函數(shù)名、變量名，最好按照一定的規(guī)則起名。還是編程規(guī)范。

3、凌波微步，未必摔跤（Evil goto's?Maybe Not...）

這里我用“凌波微步”來形容goto語句。通常，goto語句使程序跳來跳去，不容易讀，而且不能優(yōu)化，但是在某種情況下，goto語句反而可以增強(qiáng)程序的可讀性。Just go ahead，not go back。

4、先發(fā)制人，后發(fā)制于人（Practic Defensive Coding）

Defensive Coding指一些可能會(huì)出錯(cuò)的情況，如變量的初始化等，要考慮到出現(xiàn)錯(cuò)誤情況下的處理策略。測試時(shí)要多運(yùn)行幾個(gè)線程。有些程序在一個(gè)線城下運(yùn)行是正常的，但是在多個(gè)線程并行運(yùn)行時(shí)就會(huì)出現(xiàn)問題；而有些程序在一個(gè)CPU運(yùn)行幾個(gè)線程是正常的，但是在多個(gè)CPU下運(yùn)行時(shí)就會(huì)出現(xiàn)問題，因?yàn)閱蜟PU運(yùn)行線程只是狹義的并行，多CPU一起運(yùn)行程序，才是真正的并行運(yùn)算。

5、見招拆招，滴水不漏（Handle The Error Cases：They Will Occur?。?/p>

這里的Error Case（錯(cuò)誤情況），是指那些不易重視的錯(cuò)誤。如果不對Error Case進(jìn)行處理，程序在多數(shù)情況下不會(huì)出錯(cuò)，但是一旦出現(xiàn)異常，程序就會(huì)崩潰。

6、熟習(xí)劍法刀術(shù)，所向無敵（Learn Win32 API Seriously）

用“劍法刀術(shù)”來形容一些API是因?yàn)樗鼈兌际墙?jīng)過了很多優(yōu)秀開發(fā)人員的不斷開發(fā)、測試，其效率很高，而且簡潔易懂，希望大家能掌握它，熟悉它，使用它。是不是象我們的ULIB。

7、雙手互搏，無堅(jiān)不摧（Test,but don't stop there）

這里的測試不是指別人來測試你的代碼，而是指自己去測試。因?yàn)槟闶菍懘a的原作者，對代碼的了解最深，別人不可能比你更了解，所以你自己在測試時(shí)，可以很好地去測試哪些邊界條件，以及一些意向不到的情況。

8、活用斷言（Use,don't abuse,assertions）

斷言（assertion）是個(gè)很好的調(diào)試工具和方法，希望大家能多用斷言，但是并不是所有的情況下都可以用到斷言。有些情況使用斷言反而不合適。

9、草木皆兵，不可大意（Avoid Assumptions）

是指在寫代碼時(shí)，要小心一些輸入的情況，比如輸入文件、TCP的sockets、函數(shù)的參數(shù)等等，不要認(rèn)為使用我們的API的用戶都知道什么是正確的、什么是錯(cuò)的，也就是說一定要考慮到對外接口的出錯(cuò)處理問題。

10、最高境界、無招勝有招（Stop writing so much code）

意思就是說盡量避免寫太多的代碼，寫的越多，出錯(cuò)的機(jī)會(huì)也越多。最好能重用別人開放的接口函數(shù)或直接調(diào)用別人的api。