人妻暴雨中被强制侵犯在线,亚洲国产欧美日韩精品一区二区三区,四虎影免看黄,国产无人区二卡三卡四卡不见星空

機械社區(qū)

標題: 單片機開發(fā)之C語言編程基本規(guī)范 [打印本頁]

作者: tainqing    時間: 2017-8-6 10:30
標題: 單片機開發(fā)之C語言編程基本規(guī)范
本規(guī)范主要針對單片機編程語言和08編譯器而言,包括排版、注釋、命名、變量使用、代碼可測性、程序效率、質量保證等內容。
) l$ E$ Z9 O% m- \
1.基本規(guī)則 $ T8 E8 B5 I+ F$ ?& D
格式清晰、注釋簡明扼要、命名規(guī)范易懂、函數(shù)模塊化、程序易讀易維護、功能準確實現(xiàn)、代碼空間效率和時間效率高、適度的可擴展性、單片機編程規(guī)范-標識符命名
( X+ A8 @( U. v  f/ e) t7 O
2.標識符命名 2.1 命名基本原則 ! K  `4 z9 ~6 m* z1 s
1)命名清晰明了,有明確含義,使用完整單詞或約定俗成的縮寫。通常,較短的單詞可通過去掉元音字母形成縮寫;較長的單詞可取單詞的頭幾個字母形成縮寫。即"見名知意"。(2)命名風格要自始至終保持一致。
# A, n4 \, w3 A# N+ G2 B9 `
3)命名中若使用特殊約定或縮寫,要有注釋說明。) B. G+ F5 e) v2 a
4)同一軟件產品內模塊之間接口部分的標識符名稱之前加上模塊標識。9 T: ^4 q6 i9 b) v/ Z. t
2.2 宏和常量命名 1 O, n* c, a- G) U8 u  K, n
宏和常量用全部大寫字母來命名,詞與詞之間用下劃線分隔。對程序中用到的數(shù)字均應用有意義的枚舉或宏來代替。
; R% W# u, C" j$ s
2.3 變量命名
$ N2 V+ W( \# A$ G2 S3 T: ^
變量名用小寫字母命名,每個詞的第一個字母大寫。類型前綴(u8\s8 etc.)全局變量另加前綴g_。
- [+ B2 k) t0 z! N
局部變量應簡明扼要。局部循環(huán)體控制變量優(yōu)先使用i、j、k等;局部長度變量優(yōu)先使用len、num等;臨時中間變量優(yōu)先使用temp、tmp等。
- d0 \* c1 Q* B# V5 K% Y3 P
2.4 函數(shù)命名
0 }8 E. s2 s6 |0 F7 T: l% K
函數(shù)名用小寫字母命名,每個詞的第一個字母大寫,并將模塊標識加在最前面。
) e  L9 y; r  |
2.5 文件命名 : g! H9 p! x( J: h7 Y+ D
一個文件包含一類功能或一個模塊的所有函數(shù),文件名稱應清楚表明其功能或性質。; C& I' [4 [( G# p
每個.c文件應該有一個同名的.h文件作為頭文件。 6 a4 y# d4 w* j* X; x8 U  E
3.注釋 3.1 注釋基本原則
4 I/ \& `5 T1 ]0 d7 t. M
有助于對程序的閱讀理解,說明程序在"做什么",解釋代碼的目的、功能和采用的方法。) h" [5 [9 l! A/ U7 P% x
一般情況源程序有效注釋量在30%左右。- l( f! o3 r8 a; E, }4 ]
注釋語言必須準確、易懂、簡潔。
4 K3 ^/ R3 z4 c( s
邊寫代碼邊注釋,修改代碼同時修改相應的注釋,不再有用的注釋要刪除。
! Y/ z( N4 c$ Z; k' t- T0 o4 Y9 w, A
匯編和C中都用"//",取消";"  不使用段注釋" /*  */ "(調試時可用) 6 X7 \2 K6 y: v2 Q" y- u% C/ u9 r
3.2 文件注釋
$ a+ N7 W9 f& L; M* q) D
文件注釋必須說明文件名、函數(shù)功能、創(chuàng)建人、創(chuàng)建日期、版本信息等相關信息。! B( n8 b, C; X: R+ v& \
修改文件代碼時,應在文件注釋中記錄修改日期、修改人員,并簡要說明此次修改的目的。所有修改記錄必須保持完整。4 f7 I: x9 \( r# w0 f
文件注釋放在文件頂端,用"/*……*/"格式包含。
" V0 J# b; }3 b1 _3 ~4 B3 |
注釋文本每行縮進4個空格;每個注釋文本分項名稱應對齊。
: V+ U7 h7 B. H. j) {1 Z6 f
/***********************************************************/ B- W& O! i+ v3 }) H
文件名稱:" w- b: |6 N5 f) v/ I4 t5 @4 {
者:
' q+ g( O; q+ q+ l0 r& T& J* i( Q
本:, R: |% `9 q9 w- r5 r
明:
' y9 q+ B1 s9 C8 |: g- n" E
修改記錄:' m3 P2 x& S# T6 ?0 y/ p$ _
***********************************************************/
  e- O% ^+ T- Z/ m0 r, O6 l" k
3.3 函數(shù)注釋
& U5 a$ W- A# u+ J
3.3.1 函數(shù)頭部注釋# }$ {6 R& _& Y0 _2 ^( E
函數(shù)頭部注釋應包括函數(shù)名稱、函數(shù)功能、入口參數(shù)、出口參數(shù)等內容。如有必要還可增加作者、創(chuàng)建日期、修改記錄(備注)等相關項目。
6 A; B2 c3 @5 Z1 c3 P8 _
函數(shù)頭部注釋放在每個函數(shù)的頂端,用"/*……*/"的格式包含。其中函數(shù)名稱應簡寫為Name(),不加入、出口參數(shù)等信息。
% \; q& ?( K0 o5 M0 U4 Q4 V& q
/***********************************************************
- \6 I0 m% _5 k, D5 f2 Q
函數(shù)名稱:0 u. r9 `" T' J; I4 u+ A
函數(shù)功能:
7 `: [8 W: J/ T8 {/ c2 K
入口參數(shù):! J8 S0 U; m) _% f
出口參數(shù):
1 y" V' b* z; z  e
注:
+ N# A* Y  i7 S0 S
***********************************************************/: q6 i3 N" R: m8 P
3.3.2 代碼注釋信、盈、達‘騰訊:以一齊捂捂吧久零久要’
3 Z1 x+ D" A0 R; H2 X, z! z
代碼注釋應與被注釋的代碼緊鄰,放在其上方或右方,不可放在下面。如放于上方則需與其上面的代碼用空行隔開。一般少量注釋應該添加在被注釋語句的行2尾,一個函數(shù)內的多個注釋左對齊;較多注釋則應加在上方且注釋行與被注釋的語句左對齊。4 ]7 u; ?; M2 p! v1 N
函數(shù)代碼注釋用"//…//"的格式。0 w: h, O1 M- M; _
通常,分支語句(條件分支、循環(huán)語句等)必須編寫注釋。其程序塊結束行"}"的右方應加表明該程序塊結束的標記"end of ……", 尤其在多重嵌套時。
7 C% v  P" M8 D% m& b6 G
3.4 變量、常量、宏的注釋
3 Y% K0 T7 e2 T- y+ N' v8 c
同一類型的標識符應集中定義,并在定義之前一行對其共性加以統(tǒng)一注釋。對單個標識符的注釋加在定義語句的行尾。/ s, h0 B  Q6 `8 V2 H
全局變量一定要有詳細的注釋,包括其功能、取值范圍、哪些函數(shù)或過程存取它以及存取時的注意事項等。+ I5 ^0 V) \/ }, E
注釋用"//…//"的格式。 5 \' _5 e, }& h( ]( D6 L: L
! M+ z& B1 m% L; J: ]( B

作者: liangquan6    時間: 2017-8-6 14:24
不僅單片機,其余機械相關控制程序開發(fā)也應該這樣編程!
作者: 面壁深功    時間: 2017-8-6 15:43
謝謝,先收藏起來
作者: xiaobing86203    時間: 2017-8-6 19:40
單片機的基礎知識,值得收藏一波~
作者: 武漢老虎    時間: 2017-8-8 11:04
學習了
作者: tainqing    時間: 2017-8-9 18:14
共同學習進步




歡迎光臨 機械社區(qū) (http://www.xa-space.com/) Powered by Discuz! X3.5