EDA365欢迎您!
您需要 登录 才可以下载或查看,没有帐号?注册
x
本规范主要针对单片机编程语言和08编译器而言,包括排版、注释、命名、变量使用、代码可测性、程序效率、质量保证等内容。
5 A' k1 a W% _9 m* S! e1.基本规则
* Y5 C5 g+ P; S6 @9 [4 o! a格式清晰、注释简明扼要、命名规范易懂、函数模块化、程序易读易维护、功能准确实现、代码空间效率和时间效率高、适度的可扩展性、单片机编程规范-标识符命名 ! ^7 c( a* ~3 V) C4 `9 s9 |* ]3 d" ^
2.标识符命名 2.1 命名基本原则
6 a- v2 H4 v6 e# W, s$ l$ f(1)命名清晰明了,有明确含义,使用完整单词或约定俗成的缩写。通常,较短的单词可通过去掉元音字母形成缩写;较长的单词可取单词的头几个字母形成缩写。即"见名知意"。(2)命名风格要自始至终保持一致。 ) L! \; e* d+ y6 O7 c$ ?6 O
(3)命名中若使用特殊约定或缩写,要有注释说明。
$ J( i; B4 h: H8 `. o& R(4)同一软件产品内模块之间接口部分的标识符名称之前加上模块标识。
- R# b6 C- q% G' J3 v2.2 宏和常量命名
4 W1 e/ W+ c- ]! }" b5 e宏和常量用全部大写字母来命名,词与词之间用下划线分隔。对程序中用到的数字均应用有意义的枚举或宏来代替。+ o g) o' D# |
2.3 变量命名 ' M/ [8 [+ X$ A% E
变量名用小写字母命名,每个词的第一个字母大写。类型前缀(u8\s8 etc.)全局变量另加前缀g_。3 Q2 u! g& s- v0 u+ ?/ L5 N
局部变量应简明扼要。局部循环体控制变量优先使用i、j、k等;局部长度变量优先使用len、num等;临时中间变量优先使用temp、tmp等。( y0 }/ p( [9 N# f5 G/ L
2.4 函数命名 7 P: H3 }, h5 p# q* {
函数名用小写字母命名,每个词的第一个字母大写,并将模块标识加在最前面。
. }! i6 a2 O# w0 g) F3 N) w; O1 K) X2.5 文件命名 * K: R8 K) z3 P' f0 P
一个文件包含一类功能或一个模块的所有函数,文件名称应清楚表明其功能或性质。
! [/ X5 q' k( |1 V4 r" K每个.c文件应该有一个同名的.h文件作为头文件。 # x- W' S. G+ |4 m6 S
3.注释 3.1 注释基本原则
/ f8 A2 X$ e& \6 }0 w4 h! x+ ]有助于对程序的阅读理解,说明程序在"做什么",解释代码的目的、功能和采用的方法。8 n2 t+ ]4 v( D# l% R$ W2 `/ O
一般情况源程序有效注释量在30%左右。
2 U& m& Y) t1 i7 y2 A注释语言必须准确、易懂、简洁。* ?3 o7 g4 v1 |+ n. M
边写代码边注释,修改代码同时修改相应的注释,不再有用的注释要删除。
" K! c1 F# n, w( m汇编和C中都用"//",取消";" 不使用段注释" /* */ "(调试时可用) + `2 u/ ^9 a8 V8 M% V
3.2 文件注释 5 w; X7 J" K S& V& B
文件注释必须说明文件名、函数功能、创建人、创建日期、版本信息等相关信息。
6 i/ G, Y% A4 V( t' {6 p修改文件代码时,应在文件注释中记录修改日期、修改人员,并简要说明此次修改的目的。所有修改记录必须保持完整。! W% P. Y2 `7 ?5 h* X" F& v: ]
文件注释放在文件顶端,用"/*……*/"格式包含。+ H) T7 Y$ f. d' G8 u
注释文本每行缩进4个空格;每个注释文本分项名称应对齐。5 ` W2 p) j/ P8 g2 f. }
/***********************************************************. m8 C/ |7 U! l5 W6 j1 ]0 W$ @
文件名称:
6 c M8 w# o" j* t1 ]+ J r4 u7 `作 者:
( D I+ Y3 w5 e* T; D7 n版 本:5 z: E( _9 [5 b$ X9 V
说 明:
) l) w( Y# Q1 B; R% b修改记录:5 c$ P, _, o9 k0 k x$ H5 ?# R
***********************************************************/
% n/ q' l' k4 f1 ~ P" A3.3 函数注释 8 b( h- `# Z. I8 I! C
3.3.1 函数头部注释& C8 K% Q) y0 x5 p# y3 Z2 r+ l
函数头部注释应包括函数名称、函数功能、入口参数、出口参数等内容。如有必要还可增加作者、创建日期、修改记录(备注)等相关项目。
' q! o7 I0 |2 L* Q2 ]. A2 k函数头部注释放在每个函数的顶端,用"/*……*/"的格式包含。其中函数名称应简写为Name(),不加入、出口参数等信息。- v* s) E6 j: A! ~; O
/***********************************************************9 E8 r: I. W9 c. M* }8 ~
函数名称:( `, d& e; q7 r; e2 b6 x, u, M8 b' D
函数功能:
& ~$ M w0 N2 e& Y! V' E" Z入口参数:' D0 G/ C* h+ s& ]4 x; b
出口参数:0 G( }1 @2 \& q6 Z3 ?' [9 J. F
备 注:7 y; y! @9 E- x0 m3 ?+ x
***********************************************************/
1 B- ?0 c: P5 D- n) @ _! c3.3.2 代码注释(信、盈、达‘腾讯:以一齐捂捂吧久零久要’)# Q" U. s p* J {' C/ G
代码注释应与被注释的代码紧邻,放在其上方或右方,不可放在下面。如放于上方则需与其上面的代码用空行隔开。一般少量注释应该添加在被注释语句的行2尾,一个函数内的多个注释左对齐;较多注释则应加在上方且注释行与被注释的语句左对齐。
, d+ H' p2 ?& }$ k函数代码注释用"//…//"的格式。; k& s! q/ i& [/ B- }9 ]( S
通常,分支语句(条件分支、循环语句等)必须编写注释。其程序块结束行"}"的右方应加表明该程序块结束的标记"end of ……", 尤其在多重嵌套时。
9 {& S* e0 }% Z: L5 P3.4 变量、常量、宏的注释 - t- a" y( `6 r9 g8 {" c0 v; P
同一类型的标识符应集中定义,并在定义之前一行对其共性加以统一注释。对单个标识符的注释加在定义语句的行尾。
1 [4 y ^0 t% s7 U" `全局变量一定要有详细的注释,包括其功能、取值范围、哪些函数或过程存取它以及存取时的注意事项等。5 W7 K/ H$ ^, T( Y2 t: f6 G
注释用"//…//"的格式。
, {0 h8 j3 G8 o% L' E5 [; B4.函数 4.1 函数设计原则 " k6 J1 J- B& [% r% a* I
函数的基本要求: : N0 K- y+ a. u, y- q
1)封装性7 A2 ~0 n0 z: b, F5 a
1) 正确性:程序要实现设计要求的功能。
1 [2 j+ I& h) q# K" H' b: p8 _" g& S2) 稳定性和安全性:程序运行稳定、可靠、安全。
7 z, d- t- e5 [3) 可测试性:程序便于测试和评价。
0 \3 Z9 m( @, b6 A4) 规范/可读性:程序书写风格、命名规则等符合规范。, d9 z9 g P. ]% I- a
5) 扩展性:代码为下一次升级扩展留有空间和接口。# L1 B/ y! Y/ L/ _
6) 全局效率:软件系统的整体效率高。- V3 }2 ?/ G$ k v- x2 }- _- o2 \- D
7) 局部效率:某个模块/子模块/函数的本身效率高。6 |- y: V) E9 I, z9 K9 `+ ^0 T# q
编制函数的基本原则:
' n# t: `& t1 @4 ?; _: p1) 单个函数的规模尽量限制在200行以内(不包括注释和空行)。一个函数只完成一个功能。5 K9 @1 i6 l" H2 y& M9 Y8 @
2) 函数局部变量的数目一般不超过5~10个。( }6 m- W1 E1 m, I; I
3) 函数内部局部变量定义区和功能实现区(包含变量初始化)之间空一行。
2 T5 v; e1 @/ C/ q0 h4) 函数名应准确描述函数的功能。通常使用动宾词组为执行某操作的函数命名。: D9 [3 b; a; G. T7 F
5) 函数的返回值要清楚明了,尤其是出错返回值的意义要准确无误。# e& y: h4 x9 u# }$ y/ B
6) 不要把与函数返回值类型不同的变量,以编译系统默认的转换方式或强制的转换方式作为返回值返回。! s6 x' a1 ~* u8 ?5 I. d
7) 减少函数本身或函数间的递归调用。
+ m# p1 X' I( l0 T5 @ J1 x8) 尽量不要将函数的参数作为工作变量。! {5 L* Z; C# r' }) d9 K
4.2 函数定义 7 R' u) G% G5 H3 W/ A; j+ h
1) 函数若没有入口参数或者出口参数,应用void明确申明。: q" G0 _# V/ z5 V/ m$ Z7 f2 s
2) 函数名称与出口参数类型定义间应该空一格且只空一格。
/ S9 X% h, i- r. }1 B3) 函数名称与括号()之间无空格。
! H4 c( _9 O* v4 B- U" T, q4) 函数形参必须给出明确的类型定义。
* F; ?) S) u) q$ A5) 多个形参的函数,后一个形参与前一个形参的逗号分割符之间添加一个空格。
! m. v: Z5 g5 G* _, q8 p6) 函数体的前后花括号"{}" 各独占一行。' S J b+ n0 D0 K6 i
4.3 局部变量定义
, k6 o: v! |( M& ^1) 同一行内不要定义过多变量。, t) h' [; Q0 e* K
2) 同一类的变量在同一行内定义,或者在相邻行定义。
% @3 n. X8 N" U; E" Q( H! E5 P8 p4 e3) 先定义data型变量,再定义idtata型变量,再定义xdata型变量.(?)
9 Q; t3 r/ I' K4) 数组、指针等复杂类型的定义放在定义区的最后。
* V8 a" u0 I; {3 j5) 变量定义区不做较复杂的变量赋值。/ h4 Y* j, q' U, I! _
4.4 功能实现区规范 " S$ K8 M, h1 J, S
1) 一行只写一条语句。
0 h7 v3 T% q8 z9 G' ^. E9 c2) 注意运算符的优先级,并用括号明确表达式的操作顺序,避免使用默认优先级。( {7 R s$ X8 @, I5 K8 E
3) 各程序段之间使用一个空行分隔,加以必要的注释。程序段指能完一个较具体的功能的一行或多行代码。程序段内的各行代码之间相互依赖性较强。(1、2、3方式). I+ ~. @- J( k* q' M9 \0 U s4 {
4) 不要使用难懂的技巧性很高的语句。" N8 K1 \% [5 z# r# z( } f
5) 源程序中关系较为紧密的代码应尽可能相邻。
* B+ k0 T2 p3 G6) 完成简单功能、关系非常密切的一条或几条语句可编写为函数或定义为宏。 ; p$ ]" M2 c4 r$ B' m
5. 单片机编程规范-排版 $ i/ c% O1 m5 o0 R+ r5 W
3 `* \0 B% w) r% B |