VoP(!.Ua>7
为了提高源程序的质量和可维护性,从而最终提高软件产品生产力,特编写此规范。本标准规定了程序设计人员进行程序设计时必须遵循的规范。本规范主要针对单片机编程语言和08编译器而言,包括排版、注释、命名、变量使用、代码可测性、程序效率、质量保证等内容。 i2swots
1.基本规则 [.6uw=;o
格式清晰、注释简明扼要、命名规范易懂、函数模块化、程序易读易维护、功能准确实现、代码空间效率和时间效率高、适度的可扩展性、单片机编程规范-标识符命名 EcP"GO5
2.标识符命名 2.1 命名基本原则 tb_}w@:kU
(1)命名清晰明了,有明确含义,使用完整单词或约定俗成的缩写。通常,较短的单词可通过去掉元音字母形成缩写;较长的单词可取单词的头几个字母形成缩写。即"见名知意"。(2)命名风格要自始至终保持一致。 8BWLi5R[
(3)命名中若使用特殊约定或缩写,要有注释说明。 C0kwI*)
(4)同一软件产品内模块之间接口部分的标识符名称之前加上模块标识。 67f#Z&r2k
2.2 宏和常量命名 ^
*m;![$[
宏和常量用全部大写字母来命名,词与词之间用下划线分隔。对程序中用到的数字均应用有意义的枚举或宏来代替。 >r{,$)H0
2.3 变量命名 7eu7ie6
变量名用小写字母命名,每个词的第一个字母大写。类型前缀(u8\s8 etc.)全局变量另加前缀g_。 lYq
R6^
局部变量应简明扼要。局部循环体控制变量优先使用i、j、k等;局部长度变量优先使用len、num等;临时中间变量优先使用temp、tmp等。 7$b78wax
2.4 函数命名 `cVG_=2
函数名用小写字母命名,每个词的第一个字母大写,并将模块标识加在最前面。 !q$IB?8
2.5 文件命名 ;1F3.ibE
一个文件包含一类功能或一个模块的所有函数,文件名称应清楚表明其功能或性质。 BDcl1f T
每个.c文件应该有一个同名的.h文件作为头文件。 (+T|B E3*#
3.注释 3.1 注释基本原则 {L.0jAwB
有助于对程序的阅读理解,说明程序在"做什么",解释代码的目的、功能和采用的方法。 Na[bCt
一般情况源程序有效注释量在30%左右。 o>j3<#?
注释语言必须准确、易懂、简洁。 ukhI'alS,
边写代码边注释,修改代码同时修改相应的注释,不再有用的注释要删除。 <v0 d8
汇编和C中都用"//",取消";" 不使用段注释" /* */ "(调试时可用) >5XE*9
3.2 文件注释 5)EnOT"'
文件注释必须说明文件名、函数功能、创建人、创建日期、版本信息等相关信息。 q?\3m3GM
修改文件代码时,应在文件注释中记录修改日期、修改人员,并简要说明此次修改的目的。所有修改记录必须保持完整。 v`nodI
文件注释放在文件顶端,用"/*……*/"格式包含。 =SLJkw&w6
注释文本每行缩进4个空格;每个注释文本分项名称应对齐。 u QCQ$
/*********************************************************** u*PN1E
文件名称: zJtYy4jI)
作 者: 9I.="b=J)
版 本:
E#ti
说 明: 80 p7+W2m
修改记录: :@kSDy+*Q
***********************************************************/ MbjH\XRB
3.3 函数注释 oSTGs@EK
3.3.1 函数头部注释 GndF!#?N(
函数头部注释应包括函数名称、函数功能、入口参数、出口参数等内容。如有必要还可增加作者、创建日期、修改记录(备注)等相关项目。 5a4;d+
函数头部注释放在每个函数的顶端,用"/*……*/"的格式包含。其中函数名称应简写为Name(),不加入、出口参数等信息。 vE&
/*********************************************************** 3O$Q>.0 w/
函数名称: ? NVN&zD]
函数功能: |?{Zx&yUw
入口参数: L# (o(4g2
出口参数: N{oD1%
备 注: s{hJ"lv:
***********************************************************/ V"\t
3.3.2 代码注释 VxaJ[s3PQ&
代码注释应与被注释的代码紧邻,放在其上方或右方,不可放在下面。如放于上方则需与其上面的代码用空行隔开。一般少量注释应该添加在被注释语句的行尾,一个函数内的多个注释左对齐;较多注释则应加在上方且注释行与被注释的语句左对齐。 Pm
V:J9
函数代码注释用"//…//"的格式。 zq(AN<
通常,分支语句(条件分支、循环语句等)必须编写注释。其程序块结束行"}"的右方应加表明该程序块结束的标记"end of ……", 尤其在多重嵌套时。 +dIg&}Tr
3.4 变量、常量、宏的注释 kg9ZSkJr
同一类型的标识符应集中定义,并在定义之前一行对其共性加以统一注释。对单个标识符的注释加在定义语句的行尾。 m$0T" `AP`
全局变量一定要有详细的注释,包括其功能、取值范围、哪些函数或过程存取它以及存取时的注意事项等。 E3sl"d;~
注释用"//…//"的格式。 o{nBtxZ"
4.函数 4.1 函数设计原则 JtvAi\52$
函数的基本要求: ^%*%=LJm
1)封装性 7$}lkL
1) 正确性:程序要实现设计要求的功能。 2VtiL^;5
2) 稳定性和安全性:程序运行稳定、可靠、安全。 57D /"
3) 可测试性:程序便于测试和评价。 29
')Y|$,
4) 规范/可读性:程序书写风格、命名规则等符合规范。 ~B1)!5Z
5) 扩展性:代码为下一次升级扩展留有空间和接口。 YG!~v~sV
6) 全局效率:软件系统的整体效率高。 pz#oRuujY
7) 局部效率:某个模块/子模块/函数的本身效率高。 {N/(lB8
编制函数的基本原则: U
$e-e/
1) 单个函数的规模尽量限制在200行以内(不包括注释和空行)。一个函数只完成一个功能。 @My-O@C>
2) 函数局部变量的数目一般不超过5~10个。 *)H?d
3) 函数内部局部变量定义区和功能实现区(包含变量初始化)之间空一行。 3|l+&LF!IC
4) 函数名应准确描述函数的功能。通常使用动宾词组为执行某操作的函数命名。 Gpo(Zf?
5) 函数的返回值要清楚明了,尤其是出错返回值的意义要准确无误。 p.gi8%f`
6) 不要把与函数返回值类型不同的变量,以编译系统默认的转换方式或强制的转换方式作为返回值返回。 QUwSnotgU
7) 减少函数本身或函数间的递归调用。 Z^>{bW
8) 尽量不要将函数的参数作为工作变量。 ,o*x\jrGw
4.2 函数定义 ~bg?V0
1) 函数若没有入口参数或者出口参数,应用void明确申明。 #4DEb<D
2) 函数名称与出口参数类型定义间应该空一格且只空一格。 &0+;E-_
3) 函数名称与括号()之间无空格。 0a ZplE,
4) 函数形参必须给出明确的类型定义。 3g^_Fq'
5) 多个形参的函数,后一个形参与前一个形参的逗号分割符之间添加一个空格。 M')f,5i&$
6) 函数体的前后花括号"{}" 各独占一行。 %F]4)XeW-+
4.3 局部变量定义 MCjf$pZN]
1) 同一行内不要定义过多变量。 z~UqA1r
2) 同一类的变量在同一行内定义,或者在相邻行定义。 m\O<Yc keA
3) 先定义data型变量,再定义idtata型变量,再定义xdata型变量.(?) dzKI?i)x
4) 数组、指针等复杂类型的定义放在定义区的最后。 6"/cz~h
5) 变量定义区不做较复杂的变量赋值。 pa`"f&JO
4.4 功能实现区规范 _>S."cm}!k
1) 一行只写一条语句。 }L'BzSU@G
2) 注意运算符的优先级,并用括号明确表达式的操作顺序,避免使用默认优先级。 :Bz*vH
3) 各程序段之间使用一个空行分隔,加以必要的注释。程序段指能完一个较具体的功能的一行或多行代码。程序段内的各行代码之间相互依赖性较强。(1、2、3方式) Q+$+{g-8
4) 不要使用难懂的技巧性很高的语句。 H?m9HBDpn
5) 源程序中关系较为紧密的代码应尽可能相邻。 L$=6R3GI
6) 完成简单功能、关系非常密切的一条或几条语句可编写为函数或定义为宏。 |B./5 ,nSS
5. 单片机编程规范-排版 )!s f@F?
5.1 缩进 "6[fqW65
代码的每一级均往右缩进4个空格的位置。不使用Tab键 Oc}4`?oy<O
5.2 分行 ,73J#
每行语句(?????超过80个字符)要分成多行书写;长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进适当的缩进,使排版整齐,语句可读。避免把注释插入分行中。 ^M0e 0
5.3 空行
ocotO
1) 文件注释区、头文件引用区、函数间应该有且只有一行空行。 [u`v'*0d
2) 相邻函数之间应该有且只有一行空行。 6F(;=iY8
3) 函数体内相对独立的程序块之间可以用一行空行或注释来分隔。 S|CN)8Jsi
4) 函数注释和对应的函数体之间不应该有空行。 z'z_6]5
5) 文件末尾有且只有一行空行。 wJ,l"bnq
5.4 空格 >> yK_yg
1) 函数语句尾部或者注释之后不能有空格。 &FH