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

tainqing

本規(guī)范主要針對單片機(jī)編程語言和08編譯器而言，包括排版、注釋、命名、變量使用、代碼可測性、程序效率、質(zhì)量保證等內(nèi)容。
+ i; E9 E2 D7 y& e1．基本規(guī)則
格式清晰、注釋簡明扼要、命名規(guī)范易懂、函數(shù)模塊化、程序易讀易維護(hù)、功能準(zhǔn)確實(shí)現(xiàn)、代碼空間效率和時(shí)間效率高、適度的可擴(kuò)展性、單片機(jī)編程規(guī)范－標(biāo)識符命名
) U, H9 H/ s' u! \$ m- n2．標(biāo)識符命名 2.1 命名基本原則
% E% A  N6 l( f9 d  L' |' N4 D（1）命名清晰明了，有明確含義，使用完整單詞或約定俗成的縮寫。通常，較短的單詞可通過去掉元音字母形成縮寫；較長的單詞可取單詞的頭幾個(gè)字母形成縮寫。即"見名知意"。（2）命名風(fēng)格要自始至終保持一致。
2 R; L6 ~8 `  M* Y（3）命名中若使用特殊約定或縮寫，要有注釋說明。
（4）同一軟件產(chǎn)品內(nèi)模塊之間接口部分的標(biāo)識符名稱之前加上模塊標(biāo)識。
3 n" f" y& a' [' [$ M! ?# ]2.2 宏和常量命名
' S9 d0 A( d* k5 n: o# L宏和常量用全部大寫字母來命名，詞與詞之間用下劃線分隔。對程序中用到的數(shù)字均應(yīng)用有意義的枚舉或宏來代替。
6 n' q+ s7 J! {) N2.3 變量命名
+ p$ K# E- L% |9 f變量名用小寫字母命名，每個(gè)詞的第一個(gè)字母大寫。類型前綴（u8\s8 etc.）全局變量另加前綴g_。
局部變量應(yīng)簡明扼要。局部循環(huán)體控制變量優(yōu)先使用i、j、k等；局部長度變量優(yōu)先使用len、num等；臨時(shí)中間變量優(yōu)先使用temp、tmp等。
  N$ O) ^& m! W2 G2.4 函數(shù)命名
' o. o  N4 L9 |函數(shù)名用小寫字母命名，每個(gè)詞的第一個(gè)字母大寫，并將模塊標(biāo)識加在最前面。
2.5 文件命名
一個(gè)文件包含一類功能或一個(gè)模塊的所有函數(shù)，文件名稱應(yīng)清楚表明其功能或性質(zhì)。
' w0 B/ H) X' A( Y4 ^每個(gè).c文件應(yīng)該有一個(gè)同名的.h文件作為頭文件。
3．注釋 3.1 注釋基本原則
有助于對程序的閱讀理解，說明程序在"做什么"，解釋代碼的目的、功能和采用的方法。
9 ~4 }; c. H' S一般情況源程序有效注釋量在30％左右。
注釋語言必須準(zhǔn)確、易懂、簡潔。
邊寫代碼邊注釋，修改代碼同時(shí)修改相應(yīng)的注釋，不再有用的注釋要?jiǎng)h除。
匯編和C中都用"//"，取消";"  不使用段注釋" /*  */ "（調(diào)試時(shí)可用）
3.2 文件注釋
文件注釋必須說明文件名、函數(shù)功能、創(chuàng)建人、創(chuàng)建日期、版本信息等相關(guān)信息。
1 q% Y8 g9 U) k" ^; O3 p/ k3 e9 k9 T修改文件代碼時(shí)，應(yīng)在文件注釋中記錄修改日期、修改人員，并簡要說明此次修改的目的。所有修改記錄必須保持完整。
: m; e" Z0 p& V2 u! B2 K文件注釋放在文件頂端，用"/*……*/"格式包含。
注釋文本每行縮進(jìn)4個(gè)空格；每個(gè)注釋文本分項(xiàng)名稱應(yīng)對齊。
/***********************************************************
文件名稱：
作 者：
版 本：
說 明：
4 I( S' u" y1 G+ {/ X- b: N修改記錄：
/ T% p' I1 S1 E: \# B***********************************************************/
( ]$ F+ C9 ~+ O" r' i( p3.3 函數(shù)注釋
5 Y: C- C! x$ D$ h; c3.3.1 函數(shù)頭部注釋
! p9 u3 ~" o) H$ e0 I$ a! d函數(shù)頭部注釋應(yīng)包括函數(shù)名稱、函數(shù)功能、入口參數(shù)、出口參數(shù)等內(nèi)容。如有必要還可增加作者、創(chuàng)建日期、修改記錄（備注）等相關(guān)項(xiàng)目。
  X$ e+ [8 L9 w# d* I" u函數(shù)頭部注釋放在每個(gè)函數(shù)的頂端，用"/*……*/"的格式包含。其中函數(shù)名稱應(yīng)簡寫為Name()，不加入、出口參數(shù)等信息。
) [- b; V0 C7 U0 V/ i/***********************************************************
函數(shù)名稱：
函數(shù)功能：
$ z+ v5 ^* L5 a, L6 X# v, L9 k入口參數(shù)：
4 K# n* ~. {( z9 S; b3 s出口參數(shù)：
5 {8 J# u% T3 V7 j4 h" X; c備 注：
***********************************************************/
4 ?  C5 T  Y% l3 T0 [3.3.2 代碼注釋（信、盈、達(dá)‘騰訊：以一齊捂捂吧久零久要’）
& j( K, R1 Y1 N7 Y7 f代碼注釋應(yīng)與被注釋的代碼緊鄰，放在其上方或右方，不可放在下面。如放于上方則需與其上面的代碼用空行隔開。一般少量注釋應(yīng)該添加在被注釋語句的行2尾，一個(gè)函數(shù)內(nèi)的多個(gè)注釋左對齊；較多注釋則應(yīng)加在上方且注釋行與被注釋的語句左對齊。
函數(shù)代碼注釋用"//…//"的格式。
' C) ~: |/ J5 n通常，分支語句（條件分支、循環(huán)語句等）必須編寫注釋。其程序塊結(jié)束行"｝"的右方應(yīng)加表明該程序塊結(jié)束的標(biāo)記"end of ……", 尤其在多重嵌套時(shí)。
3.4 變量、常量、宏的注釋
6 A  [/ D7 e6 `# v同一類型的標(biāo)識符應(yīng)集中定義，并在定義之前一行對其共性加以統(tǒng)一注釋。對單個(gè)標(biāo)識符的注釋加在定義語句的行尾。
全局變量一定要有詳細(xì)的注釋，包括其功能、取值范圍、哪些函數(shù)或過程存取它以及存取時(shí)的注意事項(xiàng)等。
3 X- X. n8 G. \: R注釋用"//…//"的格式。
2 D0 ^$ e3 |# n6 Z1 r

liangquan6

不僅單片機(jī)，其余機(jī)械相關(guān)控制程序開發(fā)也應(yīng)該這樣編程！

面壁深功

謝謝，先收藏起來

xiaobing86203

單片機(jī)的基礎(chǔ)知識，值得收藏一波~

武漢老虎

學(xué)習(xí)了

tainqing

共同學(xué)習(xí)進(jìn)步