C51編程規(guī)范
來源： | 作者: | 發(fā)表于：2013-05-17
C51編程規(guī)范.51單片機(jī),變量的命名,定義函數(shù)
C51編程規(guī)范
作者：1KIC 發(fā)表日期：2012-2-24 17:10:44
編程首要是要考慮程序的可行性，然后是可讀性、可移植性、健壯性以及可測試性。這是總則。但是很多人忽略了可讀性、可移植性和健壯性(可調(diào)試的方法可能歌不相同)，這是不對的。
1.當(dāng)項(xiàng)目比較大時(shí)，最好分模塊編程，一個(gè)模塊一個(gè)程序，很方便修改，也便于重用和便于閱讀。
2.每個(gè)文件的開頭應(yīng)該寫明這個(gè)文件是哪個(gè)項(xiàng)目里的哪個(gè)模塊，是在什么編譯環(huán)境下編譯的，編程者(/修改者)和編程日期，值得注意的是一定不要忘了編程日期，因?yàn)橐院竽阍倏次募r(shí)，會知道大概是什么時(shí)候編寫的，有些什么功能，并且可能知道類似模塊之間的差異(有時(shí)同一模塊所用的資源不同，和單片機(jī)相連的方法也不同，或者只是在原有的模塊上加以改進(jìn))。
3.一個(gè)C源文件配置一個(gè)h頭文件或者整個(gè)項(xiàng)目的C文件配置一個(gè)h頭文件，我自己采用整個(gè)項(xiàng)目的C文件配置一個(gè)h頭文件的方法，并且使用#ifndef/#define/#endif的宏來防止重復(fù)定義，方便各模塊之間相互調(diào)用。
4.一些常量(如圓周率PI)或者常需要在調(diào)試時(shí)修改的參數(shù)最好用#define定義，但要注意宏定義只是簡單的替換，因此有些括號不可少。
5.不要輕易調(diào)用某些庫函數(shù)，因?yàn)橛行旌瘮?shù)代碼很長(我是反對使用printf之類的庫函數(shù)的，但是是一家之言，并不勉強(qiáng)各位)。
6.書寫代碼時(shí)要注意括號對齊，固定縮進(jìn)，一個(gè){}各占一行，我本人采用采用所進(jìn)4個(gè)字符，應(yīng)該還是比較合適的，if/for/while/do等語句各占一行，執(zhí)行語句不得緊跟其后，1KIC.COM無論執(zhí)行語句多少都要加{},千萬不要寫成如下格式：
for(i=0;i<100;i++){fun1();fun2();}
for(i=0;i<100;i++){
fun1();
fun2();
}
而應(yīng)該寫成：
for(i=0;i<100;i++)
{
fun1();
fun2();
}
7.一行只實(shí)現(xiàn)一個(gè)功能，比如：
a=2;b=3;c=4;宜改成：
a=2;
b=3;
c=4;
8.重要難懂的代碼要寫注釋，每個(gè)函數(shù)要寫注釋，每個(gè)全局變量要寫注釋，一些局部變量也要寫注釋。注釋寫在代碼的上方或者右方，千萬不要寫在下方(相信沒有人寫在左方吧:))。
9.對各運(yùn)算符的優(yōu)先級右所了解，記不得沒關(guān)系，加括號就是，千萬不要自作聰明說自己記得很牢。
10.不管有沒有無效分支，switch函數(shù)一定要defaut這個(gè)分支1KIC.COM。一來讓閱讀者知道程序員并沒有遺忘default,并且防止程序運(yùn)行過程中出現(xiàn)的意外(健壯性)。
11.變量和函數(shù)的命名最好能做到望文生義。不要命名什么x，y，z，a，sdrf之類的名字。
12.函數(shù)的參數(shù)和返回值沒有的話最好使用void。
13.goto語句：從匯編轉(zhuǎn)型成C的人很喜歡用goto，但goto是C語言的大忌，但是老實(shí)說，程序出錯(cuò)是程序員自己造成的，不是goto的過錯(cuò)；本人只推薦一種情況下使用goto語句，即從多層循環(huán)體中跳出。
14.指針是C語言的精華，但是在C51中我個(gè)人認(rèn)為少用為妙，一來有時(shí)反而要花費(fèi)多的空間，還有在對片外數(shù)據(jù)進(jìn)行操作時(shí)會出錯(cuò)(可能是時(shí)序的問題)。
15.一些常數(shù)和表格之類的應(yīng)該放到code去中以節(jié)省RAM。
16.程序編完編譯看有多少code多少data，注意不要使堆棧為難。
17.程序應(yīng)該要能方便的進(jìn)行測試，其實(shí)這也與編程的思維有關(guān)；一般有三種：一種是自上而下先整體再局部；一種是自下而上先局部再整體；還有一種是結(jié)合兩者往中間湊。我的做法是現(xiàn)大概規(guī)劃一下整個(gè)編程，然后一個(gè)模塊模塊獨(dú)立編程，每個(gè)模塊調(diào)試成功再拼湊在一塊調(diào)試。我建議：如果程序不大，可以直接用一個(gè)文件直接編，如果程序很大，宜采用自上而下的方式，但更多的是那種處在中間的情況，宜采用自下而上或者結(jié)合的方式。
二、命名：
命名必須具有一定的實(shí)際意義。
1、常量的命名：全部用大寫。
2、變量的命名：
變量名加前綴，前綴反映變量的數(shù)據(jù)類型，用小寫，反映變量意義的第一個(gè)字母大寫，其他小寫。
其中變量數(shù)據(jù)類型：
unsigned char 前綴 uc signed char 前綴 sc
unsigned int 前綴 ui signed int 前綴 si
unsigned long 前綴 ul signed long 前綴 sl
bit 前綴 b 指針 前綴 p
例：ucReceivData 接收數(shù)據(jù)
3、結(jié)構(gòu)體命名：
4、函數(shù)的命名：
函數(shù)名首字大寫，若包含有兩個(gè)單詞的每個(gè)單詞首字母大寫。
函數(shù)原型說明包括：引用外來函數(shù)及內(nèi)部函數(shù)，外部引用必須在右側(cè)注明函數(shù)來源： 模塊名及文件名, 內(nèi)部函數(shù)，只要注釋其定義文件名;
三、編輯風(fēng)格
1、縮進(jìn)：縮進(jìn)以 Tab 為單位，一個(gè) Tab 為四個(gè)空格大小。預(yù)處理語句、全局?jǐn)?shù)據(jù)、函數(shù)原型、標(biāo)題、附加說明、函數(shù)說明、標(biāo)號等均頂格書寫。語句塊的“{”“}”配對對齊，并與其前一行對齊；
2、空格：數(shù)據(jù)和函數(shù)在其類型，修飾名稱之間適當(dāng)空格并據(jù)情況對齊。關(guān)鍵字原則上空一格，如：
if ( ... ) 等，運(yùn)算符的空格規(guī)定如下：“->”、“[”、“]”、“++”、“--”、“~”、“!”、“+”、“-”（指正負(fù)號），“&”（取址或引用）、“*”（指使用指針時(shí)）等幾個(gè)運(yùn)算符兩邊不空格（其中單目運(yùn)算符系指與操作數(shù)相連的一邊），其它運(yùn)算符（包括大多數(shù)二目運(yùn)算符和三目運(yùn)算符“?:”兩邊均空一格，“(”、“)”運(yùn)算符在其內(nèi)側(cè)空一格，在作函數(shù)定義時(shí)還可據(jù)情況多空或不空格來對齊1KIC.COM，但在函數(shù)實(shí)現(xiàn)時(shí)可以不用?！?”運(yùn)算符只在其后空一格，需對齊時(shí)也可不空或多空格，對語句行后加的注釋應(yīng)用適當(dāng)空格與語句隔開并盡可能對齊。
3、對齊：原則上關(guān)系密切的行應(yīng)對齊，對齊包括類型、修飾、名稱、參數(shù)等各部分對齊。另每一行的長度不應(yīng)超過屏幕太多，必要時(shí)適當(dāng)換行，換行時(shí)盡可能在“,”處或運(yùn)算符處，換行后最好以運(yùn)算符打頭，并且以下各行均以該語句首行縮進(jìn)，但該語句仍以首行的縮進(jìn)為準(zhǔn)，即如其下一行為“{”應(yīng)與首行對齊。
4、空行：程序文件結(jié)構(gòu)各部分之間空兩行，若不必要也可只空一行，各函數(shù)實(shí)現(xiàn)之間一般空兩行
5、修改：版本封存以后的修改一定要將老語句用/* */ 封閉，不能自行刪除或修改,并要在文件及函數(shù)的修改記錄中加以記錄。
6、形參：在定義函數(shù)時(shí)，在函數(shù)名后面括號中直接進(jìn)行形式參數(shù)說明，不再另行說明。
