找回密码
 注册
关于网站域名变更的通知
查看: 649|回复: 5
打印 上一主题 下一主题

单片机开发之C语言编程基本规范

[复制链接]

该用户从未签到

跳转到指定楼层
1#
发表于 2017-8-6 09:50 | 只看该作者 回帖奖励 |倒序浏览 |阅读模式

EDA365欢迎您登录!

您需要 登录 才可以下载或查看,没有帐号?注册

x
本规范主要针对单片机编程语言和08编译器而言,包括排版、注释、命名、变量使用、代码可测性、程序效率、质量保证等内容。 9 |5 Z4 o" x3 D9 Q
1.基本规则
1 L8 w) f* O! K0 P
格式清晰、注释简明扼要、命名规范易懂、函数模块化、程序易读易维护、功能准确实现、代码空间效率和时间效率高、适度的可扩展性、单片机编程规范-标识符命名 4 E" M2 _2 g" E( r
2.标识符命名 2.1 命名基本原则 & E7 h- D6 ^: m& S5 E, {/ d
1)命名清晰明了,有明确含义,使用完整单词或约定俗成的缩写。通常,较短的单词可通过去掉元音字母形成缩写;较长的单词可取单词的头几个字母形成缩写。即"见名知意"。(2)命名风格要自始至终保持一致。
* S3 s5 z7 F! ~, k0 t- e
3)命名中若使用特殊约定或缩写,要有注释说明。' |# T# q( o9 Z4 G0 }9 I
4)同一软件产品内模块之间接口部分的标识符名称之前加上模块标识。
( O" ?" \' _% R( ?3 {& q
2.2 宏和常量命名 - S. T9 H. ]! C6 ?6 L$ N! B; d
宏和常量用全部大写字母来命名,词与词之间用下划线分隔。对程序中用到的数字均应用有意义的枚举或宏来代替。
" [0 @' v: H- ~# Y
2.3 变量命名 8 u3 Z  K- T- Q5 t5 ~
变量名用小写字母命名,每个词的第一个字母大写。类型前缀(u8\s8 etc.)全局变量另加前缀g_。5 o* _- _* ?2 X
局部变量应简明扼要。局部循环体控制变量优先使用i、j、k等;局部长度变量优先使用len、num等;临时中间变量优先使用temp、tmp等。
' ^' ]+ }2 F# Z$ x- T! f% o  \  J
2.4 函数命名 & l) _7 A, B2 S1 Q+ _# m$ V
函数名用小写字母命名,每个词的第一个字母大写,并将模块标识加在最前面。
' P) d7 K6 v6 b# J0 @+ P1 ~
2.5 文件命名
. h1 [7 z2 d- N* x
一个文件包含一类功能或一个模块的所有函数,文件名称应清楚表明其功能或性质。
7 S. S; d2 M" j; L
每个.c文件应该有一个同名的.h文件作为头文件。 ) Y( N" j5 M1 u% E
3.注释 3.1 注释基本原则 8 h/ l0 ]6 ]* }5 X9 o
有助于对程序的阅读理解,说明程序在"做什么",解释代码的目的、功能和采用的方法。2 v0 m6 ], o1 g6 H
一般情况源程序有效注释量在30%左右。) R. o1 n' M; _; l4 n
注释语言必须准确、易懂、简洁。
0 F7 l0 t$ \# K
边写代码边注释,修改代码同时修改相应的注释,不再有用的注释要删除。
( I8 |1 Y* k2 t- K
汇编和C中都用"//",取消";"  不使用段注释" /*  */ "(调试时可用)
# D4 U0 N, ?: ?6 o% t/ ~
3.2 文件注释
5 ~% }/ X( A% z9 V: Y
文件注释必须说明文件名、函数功能、创建人、创建日期、版本信息等相关信息。
) T+ \& y+ d) Q4 H
修改文件代码时,应在文件注释中记录修改日期、修改人员,并简要说明此次修改的目的。所有修改记录必须保持完整。! m; o2 _$ z0 Y) v! W+ }" f
文件注释放在文件顶端,用"/*……*/"格式包含。
' B& i; ~" _( Q# u/ h
注释文本每行缩进4个空格;每个注释文本分项名称应对齐。
* p& O4 s3 q9 j1 f8 n" F
/************************************************************ p% q6 b: I7 C9 z4 X- T
文件名称:
  i/ i5 ^5 q2 J, I
者:
+ L" c1 [! C1 H  K  T- J
本:+ _/ r% ^- t- c& ]8 S8 z" a
明:6 u/ _: ^, S" i$ Z$ u4 w  l7 S
修改记录:
- G& V& L7 T' E4 T  _, d9 v+ J( \
***********************************************************/
. T: d0 F3 h3 [
3.3 函数注释
! H+ D: B' P! f& E' {1 T. i9 V
3.3.1 函数头部注释
' M! N, Z! d+ G' C% Z
函数头部注释应包括函数名称、函数功能、入口参数、出口参数等内容。如有必要还可增加作者、创建日期、修改记录(备注)等相关项目。. a7 Q7 o7 ~5 I  y' a
函数头部注释放在每个函数的顶端,用"/*……*/"的格式包含。其中函数名称应简写为Name(),不加入、出口参数等信息。
2 }) q% V. n* f  z+ H# a7 X6 g
/***********************************************************+ |' e+ }$ @: A& S# o7 }
函数名称:
( |9 q1 E8 Z4 A, P8 R& j0 E
函数功能:; T; e% H2 h- B7 F$ e
入口参数:/ G" t: @. A6 ~+ s$ v' ~
出口参数:
( l3 H: Q& A4 Y2 R/ W( {
注:( `" _: u2 f. k, |
***********************************************************/
5 b( j8 ?+ \( h
3.3.2 代码注释信、盈、达‘腾讯:以一齐捂捂吧久零久要’9 C. L9 b8 r- r% i
代码注释应与被注释的代码紧邻,放在其上方或右方,不可放在下面。如放于上方则需与其上面的代码用空行隔开。一般少量注释应该添加在被注释语句的行2尾,一个函数内的多个注释左对齐;较多注释则应加在上方且注释行与被注释的语句左对齐。
. d  [7 ^3 r  N: P1 F9 x3 S) B
函数代码注释用"//…//"的格式。
0 a6 S5 V, U+ V% A# b  c2 G
通常,分支语句(条件分支、循环语句等)必须编写注释。其程序块结束行"}"的右方应加表明该程序块结束的标记"end of ……", 尤其在多重嵌套时。' e, r# E# ?3 i4 A5 g
3.4 变量、常量、宏的注释
, {) |% X+ Z4 [5 J/ N& ^
同一类型的标识符应集中定义,并在定义之前一行对其共性加以统一注释。对单个标识符的注释加在定义语句的行尾。4 i) ]  u& t8 M
全局变量一定要有详细的注释,包括其功能、取值范围、哪些函数或过程存取它以及存取时的注意事项等。/ B+ R# l( i  }2 z1 U
注释用"//…//"的格式。
& F" N" B) e. l+ S
4.函数 4.1 函数设计原则
* }2 V* u) v" {; E7 o1 m% M- ?' g
函数的基本要求:   [4 o4 C, W9 k( y' S
1)封装性
8 m7 ~) ?9 k! P: q( s1 x% b. @
1) 正确性:程序要实现设计要求的功能。
/ h! S+ D+ o$ G+ {# K
2) 稳定性和安全性:程序运行稳定、可靠、安全。( p/ X2 u( P1 }2 l/ C( C
3) 可测试性:程序便于测试和评价。
9 C6 s# t4 u. |$ C$ H4 O
4) 规范/可读性:程序书写风格、命名规则等符合规范。: v/ o- B; Z+ M4 \
5) 扩展性:代码为下一次升级扩展留有空间和接口。
/ z( T4 o/ i* G9 J- `
6) 全局效率:软件系统的整体效率高。
; @8 h$ u0 j  O) G+ f
7) 局部效率:某个模块/子模块/函数的本身效率高。
0 p8 t. Q: `. }  c* Q& W6 W8 S+ b
编制函数的基本原则:8 M1 A6 m$ o7 }6 U
1) 单个函数的规模尽量限制在200行以内(不包括注释和空行)。一个函数只完成一个功能。
) i) F. O' ^0 L/ q- \9 x1 v1 C
2) 函数局部变量的数目一般不超过5~10个。( O! d" c0 w) E7 Y, l5 |( g
3) 函数内部局部变量定义区和功能实现区(包含变量初始化)之间空一行。
3 H8 d& ~7 U# o$ S  J  @* S
4) 函数名应准确描述函数的功能。通常使用动宾词组为执行某操作的函数命名。' \5 Z# K$ t) v  n, u- K. v
5) 函数的返回值要清楚明了,尤其是出错返回值的意义要准确无误。) e9 \$ a) O6 m3 {
6) 不要把与函数返回值类型不同的变量,以编译系统默认的转换方式或强制的转换方式作为返回值返回。9 a8 M" ^2 L/ ^& A- p$ J
7) 减少函数本身或函数间的递归调用。# v7 J; S( r, P0 m' A" R6 }2 m9 ~
8) 尽量不要将函数的参数作为工作变量。( P6 u* k6 E/ \/ V: m
4.2 函数定义 , U) W/ w3 R: B  x0 U" X
1) 函数若没有入口参数或者出口参数,应用void明确申明。/ I) D) R/ k- B3 O& g6 P' y/ u
2) 函数名称与出口参数类型定义间应该空一格且只空一格。
9 s. u0 R4 _8 ~, t1 [9 ?: o
3) 函数名称与括号()之间无空格。
  O; @: U! e% \2 }1 [0 H0 `
4) 函数形参必须给出明确的类型定义。
  ^& K; Z" \0 i& ^( V- l
5) 多个形参的函数,后一个形参与前一个形参的逗号分割符之间添加一个空格。
% c6 Q% e: Z! p- y& T
6) 函数体的前后花括号"{}" 各独占一行。
, A  c9 s9 H5 ?% n
4.3 局部变量定义
2 R' d+ \; \. t9 S
1) 同一行内不要定义过多变量。  _0 h9 X  o/ P. d  x, h6 R! U
2) 同一类的变量在同一行内定义,或者在相邻行定义。4 H) s4 W6 q/ u9 f/ L
3) 先定义data型变量,再定义idtata型变量,再定义xdata型变量.(?)8 u- a! b; ]2 q& D, \4 X# ]* X! n
4) 数组、指针等复杂类型的定义放在定义区的最后。% F- J0 M# e/ ^% |
5) 变量定义区不做较复杂的变量赋值。
3 s* o1 C/ Z% _+ z
4.4 功能实现区规范
/ F- b: C% ~3 J! B! `1 v/ n- b
1) 一行只写一条语句。% }$ E! `" R, u& A
2) 注意运算符的优先级,并用括号明确表达式的操作顺序,避免使用默认优先级。
* K5 p. W1 s9 V
3) 各程序段之间使用一个空行分隔,加以必要的注释。程序段指能完一个较具体的功能的一行或多行代码。程序段内的各行代码之间相互依赖性较强。(1、2、3方式)
' X: ~, h. p3 s4 z% \
4) 不要使用难懂的技巧性很高的语句。/ N- @% p7 w' `6 s; x5 b3 I, y1 W
5) 源程序中关系较为紧密的代码应尽可能相邻。
% N+ d  j! S( t, G0 Z9 l/ G* D
6) 完成简单功能、关系非常密切的一条或几条语句可编写为函数或定义为宏。
% n2 h) b1 C9 i# O# ~
5. 单片机编程规范-排版 . T% O' e4 L( q% S9 Z( ?0 E1 B9 A

  z, k4 q3 I. T- y5 x/ A$ L

该用户从未签到

2#
发表于 2017-9-8 08:06 | 只看该作者
顶起来!!!
( t$ A& K& M8 y! S/ a# b6 t顶起来!!!5 r' n6 y7 s' A
顶起来!!!1 ~4 F. i+ u7 R
顶起来!!!

该用户从未签到

3#
 楼主| 发表于 2017-9-9 16:31 | 只看该作者
linyufeng1989 发表于 2017-9-8 08:06
: P6 H2 h, r4 X. u  C/ a. z, t顶起来!!!
* q, Q5 B1 ]; M* }* o" h顶起来!!!  V. ?: n7 a! @6 H5 u% g
顶起来!!!

# @9 `; m) O+ S! ?) B! o$ t谢谢。
/ E8 {) n. J$ f3 f

该用户从未签到

4#
发表于 2017-11-25 20:08 | 只看该作者
呵呵,等着就等着....

该用户从未签到

6#
发表于 2019-1-8 15:53 | 只看该作者
学习一下规范
您需要登录后才可以回帖 登录 | 注册

本版积分规则

关闭

推荐内容上一条 /1 下一条

EDA365公众号

关于我们|手机版|EDA365电子论坛网 ( 粤ICP备18020198号-1 )

GMT+8, 2025-6-16 08:07 , Processed in 0.093750 second(s), 26 queries , Gzip On.

深圳市墨知创新科技有限公司

地址:深圳市南山区科技生态园2栋A座805 电话:19926409050

快速回复 返回顶部 返回列表