編程做好這六點(diǎn)，你就是大師了

　　三、 添加盡可能詳盡的注釋

　　不要總覺得自己當(dāng)時(shí)記憶深刻，甚至刻骨銘心、終生難忘，時(shí)間總是會(huì)無情地證明你是錯(cuò)的，為你的程序添加詳盡的注釋，比如變量的用途、函數(shù)的調(diào)用關(guān)系、參數(shù)說明、函數(shù)功能等等都要盡可能詳細(xì)地寫明，有時(shí)候即使是寫下來，過一段時(shí)間再回頭看時(shí)還要在琢磨一陣，若是不寫，后果可想而知，別人就更沒法讀你的程序了。

　　這是我為一個(gè)函數(shù)寫的注釋，當(dāng)然每個(gè)人都有自己的寫法，我一般這樣來寫的，僅供參考哈。

　　/*=============================================================================

　　*
　　* 函 數(shù) 名： CMD_Send()
　　*
　　* 參 數(shù)：??????? length_low 數(shù)據(jù)長(zhǎng)度
　　*???????????????????? ?CMD_byte 命令字節(jié)
　　*???????????????????? ?CMD_parameter 命令參數(shù)
　　*???????????????????? ?*data 語音數(shù)據(jù)
　　* 功能描述:
　　*??????????????????? ? 發(fā)送一幀語音數(shù)據(jù)
　　*
　　* 返 回 值： 無
　　=============================================================================*/

　　四、 做好底層的定義

　　這里的意思是與硬件相關(guān)的程序，為了后期更好地編程，先做一些必要的定義，比如
?????????#define cWL_PIN_SDIO 0x04
　　#define SDIO_is_Out P1DIR |= cWL_PIN_SDIO

　　這樣以后用起來就十分的方便，就像說話一樣，使得程序十分易讀，當(dāng)然凡事過猶不及，也沒必要過多地定義，只對(duì)一些經(jīng)常使用的定義就好，也有的編程環(huán)境中，本身就已經(jīng)做了非常詳盡的定義，那么就省了你的事了，但這也未必是好事，因?yàn)槟阋ê芏鄷r(shí)間去看，去熟悉。

　　五、 合理劃分單元和函數(shù)

　　尤其在程序量比較大的時(shí)候，這一點(diǎn)就顯得尤為重要，劃分得好不好，對(duì)于后期編程影響極大。合理劃分單元說得通俗點(diǎn)就是把每一個(gè)功能單元放在一個(gè)單獨(dú)的文件中，這樣每一個(gè)文件中的程序量就不至于太長(zhǎng)，需要被外部調(diào)用的函數(shù)全部在頭文件中引出，劃分函數(shù)也很重要，函數(shù)劃分得好，可以節(jié)省很多程序空間，增強(qiáng)代碼執(zhí)行效率。這樣做的好處是極大地增強(qiáng)了程序的可移植性，下次再用到這個(gè)功能時(shí)，只需要修改底層的IO口就可以了，這樣久而久之，當(dāng)你寫的單元足夠多的時(shí)候，寫程序就變得越來越輕松了。還有在文件的起始處最好也加一些功能說明，也就是注釋，例如：

　　/*=============================================================================

　　* 說 明：
　　*??????????????? 本單元實(shí)現(xiàn)了語音輸出‘宇音天下’的功能。
　　* 作 者： XXX 2011/3/3
　　*　　=============================================================================*/

　　六、 反復(fù)修改，精益求精

　　無論我們?nèi)绾斡眯牡娜ゾ帉懗绦?，程序似乎總是有改進(jìn)的余地，當(dāng)你發(fā)現(xiàn)一個(gè)可以改進(jìn)的地方，可能是一個(gè)好的算法，也可能僅僅是一個(gè)冗余的變量，也要不厭其煩地去重新改過，這樣日積月累，就可以不斷完善你自己的程序庫(kù)，因?yàn)楫?dāng)程序庫(kù)足夠充足、足夠完善的時(shí)候，寫程序就幾乎是信手拈來了。

　　七、 總結(jié)

　　其實(shí)以上說的程序設(shè)計(jì)幾點(diǎn)經(jīng)驗(yàn)，每一點(diǎn)都是在一個(gè)最根本的原則的指引之下，那就是增強(qiáng)程序的可讀性和可移植性。最后送大家一句話，與大家共勉“If you will，you can!!!”。