編程首要是要考慮程序的可行性,然后是可讀性、可移植性、健壯性以及可測試性。這是總則。但是很多人忽略了可讀性、可移植性和健壯性(可調(diào)試的方法可能歌不相同),這是不對的。
1.當項目比較大時,最好分模塊編程,一個模塊一個程序,很方便修改,也便于重用和便于閱讀。
2.每個文件的開頭應該寫明這個文件是哪個項目里的哪個模塊,是在什么編譯環(huán)境下編譯的,編程者(/修改者)和編程日期,值得注意的是一定不要忘了編程日期,因為以后你再看文件時,會知道大概是什么時候編寫的,有些什么功能,并且可能知道類似模塊之間的差異(有時同一模塊所用的資源不同,和單片機相連的方法也不同,或者只是在原有的模塊上加以改進)。
3.一個C源文件配置一個h頭文件或者整個項目的C文件配置一個h頭文件,我自己采用整個項目的C文件配置一個h頭文件的方法,并且使用#ifndef/#define/#endif的宏來防止重復定義,方便各模塊之間相互調(diào)用。
4.一些常量(如圓周率PI)或者常需要在調(diào)試時修改的參數(shù)最好用#define定義,但要注意宏定義只是簡單的替換,因此有些括號不可少。
5.不要輕易調(diào)用某些庫函數(shù),因為有些庫函數(shù)代碼很長(我是反對使用printf之類的庫函數(shù)的,但是是一家之言,并不勉強各位)。
6.書寫代碼時要注意括號對齊,固定縮進,一個{}各占一行,我本人采用采用所進4個字符,應該還是比較合適的,if/for/while/do等語句各占一行,執(zhí)行語句不得緊跟其后,無論執(zhí)行語句多少都要加{},千萬不要寫成如下格式:
for(i=0;i<100;i++){fun1();fun2();}for(i=0;i<100;i++){fun1();fun2();}
而應該寫成:
for(i=0;i<100;i++){fun1();fun2();}
7.一行只實現(xiàn)一個功能,比如:
a=2;b=3;c=4;宜改成:
a=2;
b=3;
c=4;
8.重要難懂的代碼要寫注釋,每個函數(shù)要寫注釋,每個全局變量要寫注釋,一些局部變量也要寫注釋。注釋寫在代碼的上方或者右方,千萬不要寫在下方(相信沒有人寫在左方吧screen.width-300)this.width=screen.width-300" border=0>)。
9.對各運算符的優(yōu)先級右所了解,記不得沒關系,加括號就是,千萬不要自作聰明說自己記得很牢。
10.不管有沒有無效分支,switch函數(shù)一定要defaut這個分支。一來讓閱讀者知道程序員并沒有遺忘default,并且防止程序運行過程中出現(xiàn)的意外(健壯性)。
11.變量和函數(shù)的命名最好能做到望文生義。不要命名什么x,y,z,a,sdrf之類的名字。
12.函數(shù)的參數(shù)和返回值沒有的話最好使用void。
13.goto語句:從匯編轉(zhuǎn)型成C的人很喜歡用goto,但goto是C語言的大忌,但是老實說,程序出錯是程序員自己造成的,不是goto的過錯;本人只推薦一種情況下使用goto語句,即從多層循環(huán)體中跳出。
14.指針是C語言的精華,但是在C51中我個人認為少用為妙,一來有時反而要花費多的空間,還有在對片外數(shù)據(jù)進行操作時會出錯(可能是時序的問題)。
15.一些常數(shù)和表格之類的應該放到code去中以節(jié)省RAM。
16.程序編完編譯看有多少code多少data,注意不要使堆棧為難。
17.程序應該要能方便的進行測試,其實這也與編程的思維有關;一般有三種:一種是自上而下先整體再局部;一種是自下而上先局部再整體;還有一種是結合兩者往中間湊。我的做法是現(xiàn)大概規(guī)劃一下整個編程,然后一個模塊模塊獨立編程,每個模塊調(diào)試成功再拼湊在一塊調(diào)試。我建議:如果程序不大,可以直接用一個文件直接編,如果程序很大,宜采用自上而下的方式,但更多的是那種處在中間的情況,宜采用自下而上或者結合的方式。
//以下是《模塊》或《文件》注釋內(nèi)容:
///////////////////////////////////////////////////////////////////////公司名稱://模塊名://創(chuàng)建者://修改者://功能描述://其他說明://版本:///////////////////////////////////////////////////////////////////////以下是《函數(shù)》注釋內(nèi)容:///////////////////////////////////////////////////////////////////////函數(shù)名://功能描述://函數(shù)說明://調(diào)用函數(shù)://全局變量://輸入://返回://設計者://修改者://版本://///////////////////////////////////////////////////////////////////
作為一門工具,最終的目的就是實現(xiàn)功能。在滿足這個前提條件下,我們希望我們的程序能很
容易地被別人讀懂,或者能夠很容易地讀懂別人的程序,在團體合作開 發(fā)中就能起到事半功倍之效。
在網(wǎng)上請求幫助時,如能以規(guī)范的寫法貼出程序,網(wǎng)友會比較容易地明白你的問題,則會比較快的得
到網(wǎng)友的幫助,否則讓人看上半天 也不明所以然,這樣就達不到預期的效果了。因此,為了便于源
程序的交流,減少合作開發(fā)中的障礙,希望大家能夠探討一下 C51 的編程規(guī)范。把各人認為好的建 議
提出來,然后做一個總結,作為一種大家一致認同的規(guī)范,我認為將會是一件很有意義的事。我先提
出一些自已的想法,以此拋磚引玉。
一、注釋
1,采用中文;
2,開始的注釋:
文件(模塊)注釋內(nèi)容:
公司名稱、版權、作者名稱、修改時間、模塊功能、背景介紹等,復雜的算法需要加上流程說明;
比如:
/*********************************************************************//*公司名稱:*//*模塊名:LCD模塊LCD型號:HD44780*//*創(chuàng)建人:zhaojunjie日期:2001-06-08*//*修改人:日期:2001-06-08*//*功能描述:*//*其他說明:*//*版本:/**********************************************************************/
函數(shù)開頭的注釋內(nèi)容:
函數(shù)名稱、功能、說明 輸入、返回、函數(shù)描述、流程處理、全局變量、調(diào)用樣例等,復雜的函數(shù)
需要加上變量用途說明;
/***********************************************************************函數(shù)名:v_LcdInit*功能描述:LCD初始化*函數(shù)說明:初始化命令:0x3c,0x08,0x01,0x06,0x10,0x0c*調(diào)用函數(shù):v_Delaymsec(),v_LcdCmd()*全局變量:*輸入:無*返回:無*設計者:zhao日期:2001-12-09*修改者:zhao日期:2001-12-09*版本:***********************************************************************/
3、程序中的注釋內(nèi)容:
修改時間和作者、方便理解的注釋等。注釋內(nèi)容應簡煉、清楚、明了,一目了然的語句不加注釋。
二、命名:
命名必須具有一定的實際意義。
1、常量的命名:全部用大寫。
2、變量的命名:
變量名加前綴,前綴反映變量的數(shù)據(jù)類型,用小寫,反映變量意義的第一個字母大寫,其他小寫。
其中變量數(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、結構體命名:
4、函數(shù)的命名:
函數(shù)名首字大寫,若包含有兩個單詞的每個單詞首字母大寫。
函數(shù)原型說明包括:引用外來函數(shù)及內(nèi)部函數(shù),外部引用必須在右側(cè)注明函數(shù)來源: 模塊名及文件名, 內(nèi)部函數(shù),只要注釋其定義文件名;
三、編輯風格
1、縮進:縮進以 Tab 為單位,一個 Tab 為四個空格大小。預處理語句、全局數(shù)據(jù)、函數(shù)原型、標題、附加說明、函數(shù)說明、標號等均頂格書寫。語句塊的“{”“}”配對對齊,并與其前一行對齊;
2、空格:數(shù)據(jù)和函數(shù)在其類型,修飾名稱之間適當空格并據(jù)情況對齊。關鍵字原則上空一格,如:
if ( ... ) 等,運算符的空格規(guī)定如下:“->”、“[”、“]”、“++”、“--”、“~”、“!”、“+”、“-”(指正負號),“&”(取址或引用)、“*”(指使用指針時)等幾個運算符兩邊不空格(其中單目運算符系指與操作數(shù)相連的一邊),其它運算符(包括大多數(shù)二目運算符和三目運算符“?:”兩邊均空一格,“(”、“)”運算符在其內(nèi)側(cè)空一格,在作函數(shù)定義時還可據(jù)情況多空或不空格來對齊,但在函數(shù)實現(xiàn)時可以不用?!?”運算符只在其后空一格,需對齊時也可不空或多空格,對語句行后加的注釋應用適當空格與語句隔開并盡可能對齊。
3、對齊:原則上關系密切的行應對齊,對齊包括類型、修飾、名稱、參數(shù)等各部分對齊。另每一行的長度不應超過屏幕太多,必要時適當換行,換行時盡可能在“,”處或運算符處,換行后最好以運算符打頭,并且以下各行均以該語句首行縮進,但該語句仍以首行的縮進為準,即如其下一行為“{”應與首行對齊。
4、空行:程序文件結構各部分之間空兩行,若不必要也可只空一行,各函數(shù)實現(xiàn)之間一般空兩行
5、修改:版本封存以后的修改一定要將老語句用/* */ 封閉,不能自行刪除或修改,并要在文件及函數(shù)的修改記錄中加以記錄。
6、形參:在定義函數(shù)時,在函數(shù)名后面括號中直接進行形式參數(shù)說明,不再另行說明