單片機(jī)開發(fā)之C語言編程基本規(guī)范

tainqing · 發(fā)表于 2017-10-14 11:20:06

為了提高源程序的質(zhì)量和可維護(hù)性,，從而最終提高軟件產(chǎn)品生產(chǎn)力，特編寫此規(guī)范,。本標(biāo)準(zhǔn)規(guī)定了程序設(shè)計(jì)人員進(jìn)行程序設(shè)計(jì)時(shí)必須遵循的規(guī)范,。本規(guī)范主要針對單片機(jī)編程語言和08編譯器而言，包括排版,、注釋,、命名、變量使用,、代碼可測性,、程序效率、質(zhì)量保證等內(nèi)容,。
1．基本規(guī)則
格式清晰,、注釋簡明扼要、命名規(guī)范易懂,、函數(shù)模塊化、程序易讀易維護(hù),、功能準(zhǔn)確實(shí)現(xiàn),、代碼空間效率和時(shí)間效率高、適度的可擴(kuò)展性,、單片機(jī)編程規(guī)范－標(biāo)識符命名
2．標(biāo)識符命名 2.1 命名基本原則
（1）命名清晰明了,，有明確含義，使用完整單詞或約定俗成的縮寫,。通常,，較短的單詞可通過去掉元音字母形成縮寫；較長的單詞可取單詞的頭幾個(gè)字母形成縮寫。即"見名知意",。（2）命名風(fēng)格要自始至終保持一致,。
（3）命名中若使用特殊約定或縮寫，要有注釋說明,。
（4）同一軟件產(chǎn)品內(nèi)模塊之間接口部分的標(biāo)識符名稱之前加上模塊標(biāo)識,。
2.2 宏和常量命名
宏和常量用全部大寫字母來命名，詞與詞之間用下劃線分隔,。對程序中用到的數(shù)字均應(yīng)用有意義的枚舉或宏來代替,。
2.3 變量命名
變量名用小寫字母命名，每個(gè)詞的第一個(gè)字母大寫,。類型前綴（u8\s8 etc.）全局變量另加前綴g_,。
局部變量應(yīng)簡明扼要。局部循環(huán)體控制變量優(yōu)先使用i,、j,、k等；局部長度變量優(yōu)先使用len,、num等,；臨時(shí)中間變量優(yōu)先使用temp、tmp等,。
2.4 函數(shù)命名
函數(shù)名用小寫字母命名,，每個(gè)詞的第一個(gè)字母大寫，并將模塊標(biāo)識加在最前面,。
2.5 文件命名
一個(gè)文件包含一類功能或一個(gè)模塊的所有函數(shù),，文件名稱應(yīng)清楚表明其功能或性質(zhì)。
每個(gè).c文件應(yīng)該有一個(gè)同名的.h文件作為頭文件,。
3．注釋 3.1 注釋基本原則
有助于對程序的閱讀理解,，說明程序在"做什么"，解釋代碼的目的,、功能和采用的方法,。
一般情況源程序有效注釋量在30％左右。
注釋語言必須準(zhǔn)確,、易懂,、簡潔。
邊寫代碼邊注釋,，修改代碼同時(shí)修改相應(yīng)的注釋,，不再有用的注釋要刪除。
匯編和C中都用"//",，取消";"  不使用段注釋" /*  */ "（調(diào)試時(shí)可用）
3.2 文件注釋
文件注釋必須說明文件名,、函數(shù)功能、創(chuàng)建人、創(chuàng)建日期,、版本信息等相關(guān)信息,。
修改文件代碼時(shí)，應(yīng)在文件注釋中記錄修改日期,、修改人員,，并簡要說明此次修改的目的。所有修改記錄必須保持完整,。
文件注釋放在文件頂端,，用"/*……*/"格式包含。
注釋文本每行縮進(jìn)4個(gè)空格,；每個(gè)注釋文本分項(xiàng)名稱應(yīng)對齊,。
/***********************************************************
文件名稱：
作者：
版本：
說明：
修改記錄：
***********************************************************/
3.3 函數(shù)注釋
3.3.1 函數(shù)頭部注釋
函數(shù)頭部注釋應(yīng)包括函數(shù)名稱、函數(shù)功能,、入口參數(shù),、出口參數(shù)等內(nèi)容。如有必要還可增加作者,、創(chuàng)建日期,、修改記錄（備注）等相關(guān)項(xiàng)目。
函數(shù)頭部注釋放在每個(gè)函數(shù)的頂端,，用"/*……*/"的格式包含,。其中函數(shù)名稱應(yīng)簡寫為Name()，不加入,、出口參數(shù)等信息,。
/***********************************************************
函數(shù)名稱：
函數(shù)功能：
入口參數(shù)：
出口參數(shù)：
備注：
***********************************************************/
3.3.2 代碼注釋
代碼注釋應(yīng)與被注釋的代碼緊鄰，放在其上方或右方,，不可放在下面,。如放于上方則需與其上面的代碼用空行隔開。一般少量注釋應(yīng)該添加在被注釋語句的行尾,，一個(gè)函數(shù)內(nèi)的多個(gè)注釋左對齊,；較多注釋則應(yīng)加在上方且注釋行與被注釋的語句左對齊信盈達(dá)嵌入式企鵝要妖氣嗚嗚吧久零就要。
函數(shù)代碼注釋用"//…//"的格式,。
通常,，分支語句（條件分支、循環(huán)語句等）必須編寫注釋,。其程序塊結(jié)束行"｝"的右方應(yīng)加表明該程序塊結(jié)束的標(biāo)記"end of ……", 尤其在多重嵌套時(shí)。
3.4 變量,、常量,、宏的注釋
同一類型的標(biāo)識符應(yīng)集中定義，并在定義之前一行對其共性加以統(tǒng)一注釋。對單個(gè)標(biāo)識符的注釋加在定義語句的行尾,。
全局變量一定要有詳細(xì)的注釋,，包括其功能、取值范圍,、哪些函數(shù)或過程存取它以及存取時(shí)的注意事項(xiàng)等,。
注釋用"//…//"的格式。
4．函數(shù) 4.1 函數(shù)設(shè)計(jì)原則
函數(shù)的基本要求：
1）封裝性
1) 正確性：程序要實(shí)現(xiàn)設(shè)計(jì)要求的功能,。
2) 穩(wěn)定性和安全性：程序運(yùn)行穩(wěn)定,、可靠、安全,。
3) 可測試性：程序便于測試和評價(jià),。
4) 規(guī)范／可讀性：程序書寫風(fēng)格、命名規(guī)則等符合規(guī)范,。
5) 擴(kuò)展性：代碼為下一次升級擴(kuò)展留有空間和接口,。
6) 全局效率：軟件系統(tǒng)的整體效率高。
7) 局部效率：某個(gè)模塊／子模塊/函數(shù)的本身效率高,。
編制函數(shù)的基本原則：
1) 單個(gè)函數(shù)的規(guī)模盡量限制在200行以內(nèi)（不包括注釋和空行）,。一個(gè)函數(shù)只完成一個(gè)功能。
2) 函數(shù)局部變量的數(shù)目一般不超過5～10個(gè),。
3) 函數(shù)內(nèi)部局部變量定義區(qū)和功能實(shí)現(xiàn)區(qū)（包含變量初始化）之間空一行,。
4) 函數(shù)名應(yīng)準(zhǔn)確描述函數(shù)的功能。通常使用動賓詞組為執(zhí)行某操作的函數(shù)命名,。
5) 函數(shù)的返回值要清楚明了,，尤其是出錯(cuò)返回值的意義要準(zhǔn)確無誤。
6) 不要把與函數(shù)返回值類型不同的變量,，以編譯系統(tǒng)默認(rèn)的轉(zhuǎn)換方式或強(qiáng)制的轉(zhuǎn)換方式作為返回值返回,。
7) 減少函數(shù)本身或函數(shù)間的遞歸調(diào)用。
8) 盡量不要將函數(shù)的參數(shù)作為工作變量,。
4.2 函數(shù)定義
1) 函數(shù)若沒有入口參數(shù)或者出口參數(shù),，應(yīng)用void明確申明。
2) 函數(shù)名稱與出口參數(shù)類型定義間應(yīng)該空一格且只空一格,。
3) 函數(shù)名稱與括號()之間無空格,。
4) 函數(shù)形參必須給出明確的類型定義。
5) 多個(gè)形參的函數(shù),，后一個(gè)形參與前一個(gè)形參的逗號分割符之間添加一個(gè)空格,。
6) 函數(shù)體的前后花括號"｛｝" 各獨(dú)占一行。
4.3 局部變量定義
1) 同一行內(nèi)不要定義過多變量,。
2) 同一類的變量在同一行內(nèi)定義,，或者在相鄰行定義,。
3) 先定義data型變量，再定義idtata型變量,，再定義xdata型變量.（,？）
4) 數(shù)組、指針等復(fù)雜類型的定義放在定義區(qū)的最后,。
5) 變量定義區(qū)不做較復(fù)雜的變量賦值,。
4.4 功能實(shí)現(xiàn)區(qū)規(guī)范
1) 一行只寫一條語句。
2) 注意運(yùn)算符的優(yōu)先級,，并用括號明確表達(dá)式的操作順序,，避免使用默認(rèn)優(yōu)先級信盈達(dá)嵌入式企鵝要妖氣嗚嗚吧久零就要。
3) 各程序段之間使用一個(gè)空行分隔,，加以必要的注釋,。程序段指能完一個(gè)較具體的功能的一行或多行代碼。程序段內(nèi)的各行代碼之間相互依賴性較強(qiáng),。(1,、2、3方式)
4) 不要使用難懂的技巧性很高的語句,。
5) 源程序中關(guān)系較為緊密的代碼應(yīng)盡可能相鄰,。
6) 完成簡單功能、關(guān)系非常密切的一條或幾條語句可編寫為函數(shù)或定義為宏,。
5．單片機(jī)編程規(guī)范－排版
5.1 縮進(jìn)
代碼的每一級均往右縮進(jìn)4個(gè)空格的位置,。不使用Tab鍵
5.2 分行
每行語句（？,？,？？,？超過80個(gè)字符）要分成多行書寫,；長表達(dá)式要在低優(yōu)先級操作符處劃分新行，操作符放在新行之首,，劃分出的新行要進(jìn)適當(dāng)?shù)目s進(jìn),，使排版整齊，語句可讀,。避免把注釋插入分行中,。
5.3 空行
1) 文件注釋區(qū)、頭文件引用區(qū),、函數(shù)間應(yīng)該有且只有一行空行,。
2) 相鄰函數(shù)之間應(yīng)該有且只有一行空行。
3) 函數(shù)體內(nèi)相對獨(dú)立的程序塊之間可以用一行空行或注釋來分隔,。
4) 函數(shù)注釋和對應(yīng)的函數(shù)體之間不應(yīng)該有空行,。
5) 文件末尾有且只有一行空行,。
5.4 空格
1) 函數(shù)語句尾部或者注釋之后不能有空格,。
2) 括號內(nèi)側(cè)（即左括號后面和右括號前面）不加空格,，多重括號間不加空格。
3) 函數(shù)形參之間應(yīng)該有且只有一個(gè)空格（形參逗號后面加空格）,。
4) 同一行中定義的多個(gè)變量間應(yīng)該有且只有一個(gè)空格（變量逗號后面加空格）,。
5) 表達(dá)式中，若有多個(gè)操作符連寫的情況,，應(yīng)使用空格對它們分隔：
6) 在兩個(gè)以上的關(guān)鍵字,、變量、常量進(jìn)行對等操作時(shí),，它們之間的操作符前后均加一個(gè)空格,；在兩個(gè)以上的關(guān)鍵字、變量,、常量進(jìn)行非對等操作時(shí),，其前后均不應(yīng)加空格；
7) 逗號只在后面加空格,；
8) 雙目操作符,，如比較操作符, 賦值操作符"="、"+=",，算術(shù)操作符"+",、"%"，邏輯操作符"&&",、"&",，位操作符"<<"、"^"等,，前后均加一個(gè)空格,；
9) 單目操作符，如"!",、"~",、"++"、"-",、"&"（地址運(yùn)算符）等,，前后不加空格；
10) "->",、"."前后不加空格,；
11) if、for,、while,、switch等關(guān)鍵字與后面的括號間加一個(gè)空格,；
5.5 花括號
1)  if、else if,、else,、for、while語句無論其執(zhí)行體是一條語句還是多條語句都必須加花括號,，且左右花括號各獨(dú)占一行,。
2)  do{}while()結(jié)構(gòu)中，"do"和"{"均各占一行,，"}"和"while();"共同占用一行,。
if ( ) do
{ {
} }while( );
else
{
}
嵌套越少越好，{}不準(zhǔn)超過3層
5.6 switch語句
1) 每個(gè)case和其判據(jù)條件獨(dú)占一行,。
2) 每個(gè)case程序塊需用break結(jié)束,。特殊情況下需要從一個(gè)case塊順序執(zhí)行到下一個(gè)case塊的時(shí)候除外，但需要花括號在交界處明確注釋如此操作的原因,，以防止出錯(cuò),。
3) case程序塊之間空一行，且只空一行,。
4) 每個(gè)case程序塊的執(zhí)行語句保持4個(gè)空格的縮進(jìn),。
5) 一般情況下都應(yīng)該包含default分支。
Switch ( )
{
case x:
break;
case x:
break;
default:
break;
}
6．程序結(jié)構(gòu) 6.1 基本要求
1) 有main()函數(shù)的.c文件應(yīng)將main()放在最前面,，并明確用void聲明參數(shù)和返回值,。
2) 對由多個(gè).c文件組成的模塊程序或完整監(jiān)控程序，建立公共引用頭文件,，將需要引用的庫頭文件,、標(biāo)準(zhǔn)寄存器定義頭文件、自定義的頭文件,、全局變量等均包含在內(nèi),，供每個(gè)文件引用。通常,，標(biāo)準(zhǔn)函數(shù)庫頭文件采用尖角號< >標(biāo)志文件名,，自定義頭文件采用雙撇號″″標(biāo)志文件名。
3) 每個(gè).c文件有一個(gè)對應(yīng)的.h文件,，.c文件的注釋之后首先定義一個(gè)唯一的文件標(biāo)志宏,，并在對應(yīng)的.h文件中解析該標(biāo)志。
在.c文件中：
#define FILE_FLAG
在.h文件中：&
6．程序結(jié)構(gòu) 6.1 基本要求
1) 有main()函數(shù)的.c文件應(yīng)將main()放在最前面,，并明確用void聲明參數(shù)和返回值,。
2) 對由多個(gè).c文件組成的模塊程序或完整監(jiān)控程序，建立公共引用頭文件,，將需要引用的庫頭文件,、標(biāo)準(zhǔn)寄存器定義頭文件,、自定義的頭文件、全局變量等均包含在內(nèi),，供每個(gè)文件引用,。通常，標(biāo)準(zhǔn)函數(shù)庫頭文件采用尖角號< >標(biāo)志文件名,，自定義頭文件采用雙撇號″″標(biāo)志文件名,。
3) 每個(gè).c文件有一個(gè)對應(yīng)的.h文件，.c文件的注釋之后首先定義一個(gè)唯一的文件標(biāo)志宏,，并在對應(yīng)的.h文件中解析該標(biāo)志。
在.c文件中：
#define FILE_FLAG
在.h文件中：
#ifdef FILE_FLAG
#define XXX
#else
#define XXX extern
#endif
4)  對于確定只被某個(gè).c文件調(diào)用的定義可以單獨(dú)列在一個(gè)頭文件中,、單獨(dú)調(diào)用,。

xiaobing86203 · 發(fā)表于 2017-10-14 12:38:19

搞單片機(jī)的，電氣都是高手�,�,；比只編PLC強(qiáng)多了

TM-2017 · 發(fā)表于 2017-10-14 14:58:23

學(xué)習(xí)力

TM-2017 · 發(fā)表于 2017-10-14 14:58:47

學(xué)習(xí)了

余罪HN · 發(fā)表于 2017-10-14 16:58:35

大學(xué)里可惜沒好好學(xué)

韓寒11 · 發(fā)表于 2017-10-14 21:42:52

單片機(jī)是一種集成電路芯片，是采用超大規(guī)模集成電路技術(shù)把具有數(shù)據(jù)處理能力的中央處理器CPU,、隨機(jī)存儲器RAM,、只讀存儲器ROM、多種I/O口和中斷系統(tǒng),、定時(shí)器/計(jì)數(shù)器等功能(可能還包括顯示驅(qū)動電路,、脈寬調(diào)制電路、模擬多路轉(zhuǎn)換器,、A/D轉(zhuǎn)換器等電路)集成到一塊硅片上構(gòu)成的一個(gè)小而完善的微型計(jì)算機(jī)系統(tǒng),，在工業(yè)控制領(lǐng)域廣泛應(yīng)用

tainqing · 發(fā)表于 2017-11-12 16:03:57

余罪HN 發(fā)表于 2017-10-14 16:58
w" d! C. L5 F; L. A大學(xué)里可惜沒好好學(xué)

現(xiàn)在想學(xué)習(xí)也不晚啊，知識和技術(shù)都是給想學(xué)和愿意學(xué)習(xí)的人的,！qq1175589091

余罪HN · 發(fā)表于 2017-11-13 09:35:54

tainqing 發(fā)表于 2017-11-12 16:030 a; Y8 u" x' l- S0 Y
現(xiàn)在想學(xué)習(xí)也不晚啊,，知識和技術(shù)都是給想學(xué)和愿意學(xué)習(xí)的人的！qq1175589091

現(xiàn)在用不到呀,。,。。我從事的是鍛造加工這一塊的,。,。學(xué)英語比較靠譜，都是出口的,，客戶都是老外,。,。。不過知識給想學(xué)的人這點(diǎn)沒錯(cuò)

vibecoo · 發(fā)表于 2019-4-4 15:55:37

學(xué)習(xí)

咚咚嚨咚嗆 · 發(fā)表于 2019-4-23 17:23:09

學(xué)習(xí)了,，多謝樓主

		自動登錄	找回密碼
密碼			注冊會員