談?wù)凜51的編程規(guī)范
現(xiàn)在單片機的程序設(shè)計,C51已經(jīng)得到廣泛的推廣和應(yīng)用,算是單片機的主流設(shè)計程序,甚至可以說作為單片機開發(fā)人員必須要掌握的一門語言了。
作為一門工具,最終的目的就是實現(xiàn)功能。在滿足這個前提條件下,我們希望我們的程序能很容易地被別人讀懂,或者能夠很容易地讀懂別人的程序,在團體合作開發(fā)中就能起到事半功倍之效。在網(wǎng)上請求幫助時,如能以規(guī)范的寫法貼出程序,網(wǎng)友會比較容易地明白你的問題,則會比較快的得到網(wǎng)友的幫助,否則讓人看上半天也不明所以然,這樣就達不到預(yù)期的效果了。因此,為了便于源程序的交流,減少合作開發(fā)中的障礙,希望大家能夠探討一下C51的編程規(guī)范。把各人認(rèn)為好的建議提出來,然后做一個總結(jié),作為一種大家一致認(rèn)同的規(guī)范,我認(rèn)為將會是一件很有意義的事。我先提出一些自已的想法,以此拋磚引玉。
一、注釋
1,采用中文;
2,開始的注釋:
文件(模塊)注釋內(nèi)容:
公司名稱、版權(quán)、作者名稱、修改時間、模塊功能、背景介紹等,復(fù)雜的算法需要加上流程說明;
比如:
/*模 塊 名: LCD 模塊 LCD 型號:HD44780 */
/*創(chuàng) 建 人:zhaojunjie 日期:2001-06-08 */
/*版 本:
函數(shù)開頭的注釋內(nèi)容:
函數(shù)名稱、功能、說明輸入、返回、函數(shù)描述、流程處理、全局變量、調(diào)用樣例等,復(fù)雜的函數(shù)需要加上變量用途說明;
/*********************************************************************
*
* 函 數(shù) 名: v_LcdInit
* 功能描述: LCD初始化
* 函數(shù)說明: 初始化命令:0x3c, 0x08, 0x01, 0x06, 0x10, 0x0c
* 調(diào)用函數(shù): v_Delaymsec(),v_LcdCmd()
* 全局變量:
* 輸 入: 無
* 返 回: 無
* 設(shè) 計 者:zhao 日期:2001-12-09
* 修 改 者:zhao 日期:2001-12-09
* 版 本:
***********************************************************************/
3、程序中的注釋內(nèi)容:
修改時間和作者、方便理解的注釋等。注釋內(nèi)容應(yīng)簡煉、清楚、明了,一目了然的語句不加注釋。
二、命名:
命名必須具有一定的實際意義。
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、結(jié)構(gòu)體命名:
4、函數(shù)的命名:
函數(shù)名首字大寫,若包含有兩個單詞的每個單詞首字母大寫。
函數(shù)原型說明包括:引用外來函數(shù)及內(nèi)部函數(shù),外部引用必須在右側(cè)注明函數(shù)來源:模塊名及文件名, 內(nèi)部函數(shù),只要注釋其定義文件名;
三、編輯風(fēng)格
1、縮進:縮進以 Tab 為單位,一個 Tab 為四個空格大小。預(yù)處理語句、全局?jǐn)?shù)據(jù)、函數(shù)原型、標(biāo)題、附加說明、函數(shù)說明、標(biāo)號等均頂格書寫。語句塊的“{”“}”配對對齊,并與其前一行對齊;
2、空格:數(shù)據(jù)和函數(shù)在其類型,修飾名稱之間適當(dāng)空格并據(jù)情況對齊。關(guān)鍵字原則上空一格,如:
if ( ... ) 等,運算符的空格規(guī)定如下:“->”、“[”、“]”、“++”、“--”、“~”、“!”、“+”、“-”(指正負號),“”(取址或引用)、“*”(指使用指針時)等幾個運算符兩邊不空格(其中單目運算符系指與操作數(shù)相連的一邊),其它運算符(包括大多數(shù)二目運算符和三目運算符“?:”兩邊均空一格,“(”、“)”運算符在其內(nèi)側(cè)空一格,在作函數(shù)定義時還可據(jù)情況多空或不空格來對齊,但在函數(shù)實現(xiàn)時可以不用?!?”運算符只在其后空一格,需對齊時也可不空或多空格,對語句行后加的注釋應(yīng)用適當(dāng)空格與語句隔開并盡可能對齊。
3、對齊:原則上關(guān)系密切的行應(yīng)對齊,對齊包括類型、修飾、名稱、參數(shù)等各部分對齊。另每一行的長度不應(yīng)超過屏幕太多,必要時適當(dāng)換行,換行時盡可能在“,”處或運算符處,換行后最好以運算符打頭,并且以下各行均以該語句首行縮進,但該語句仍以首行的縮進為準(zhǔn),即如其下一行為“{”應(yīng)與首行對齊。
4、空行:程序文件結(jié)構(gòu)各部分之間空兩行,若不必要也可只空一行,各函數(shù)實現(xiàn)之間一般空兩行
5、修改:版本封存以后的修改一定要將老語句用封閉,不能自行刪除或修改,并要在文件及函數(shù)的修改記錄中加以記錄。
6、形參:在定義函數(shù)時,在函數(shù)名后面括號中直接進行形式參數(shù)說明,不再另行說明。
評論