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

tainqing

本规范主要针对单片机编程语言和08编译器而言，包括排版、注释、命名、变量使用、代码可测性、程序效率、质量保证等内容。
1．基本规则
格式清晰、注释简明扼要、命名规范易懂、函数模块化、程序易读易维护、功能准确实现、代码空间效率和时间效率高、适度的可扩展性、单片机编程规范－标识符命名
2．标识符命名 2.1 命名基本原则
（1）命名清晰明了，有明确含义，使用完整单词或约定俗成的缩写。通常，较短的单词可通过去掉元音字母形成缩写；较长的单词可取单词的头几个字母形成缩写。即"见名知意"。（2）命名风格要自始至终保持一致。
（3）命名中若使用特殊约定或缩写，要有注释说明。
1 w/ l  @! `. Z（4）同一软件产品内模块之间接口部分的标识符名称之前加上模块标识。
2.2 宏和常量命名
宏和常量用全部大写字母来命名，词与词之间用下划线分隔。对程序中用到的数字均应用有意义的枚举或宏来代替。
$ X2 w: U! A5 l) i2.3 变量命名
变量名用小写字母命名，每个词的第一个字母大写。类型前缀（u8\s8 etc.）全局变量另加前缀g_。
局部变量应简明扼要。局部循环体控制变量优先使用i、j、k等；局部长度变量优先使用len、num等；临时中间变量优先使用temp、tmp等。
2.4 函数命名
# P( n. d7 b+ U# b函数名用小写字母命名，每个词的第一个字母大写，并将模块标识加在最前面。
2.5 文件命名
一个文件包含一类功能或一个模块的所有函数，文件名称应清楚表明其功能或性质。
  h5 @2 Y' g4 o# Y3 d6 v' {. W5 F) z每个.c文件应该有一个同名的.h文件作为头文件。
6 c9 M$ o! f% F% [5 Z, L* |3．注释 3.1 注释基本原则
有助于对程序的阅读理解，说明程序在"做什么"，解释代码的目的、功能和采用的方法。
( x, u& t8 X9 }8 e3 x一般情况源程序有效注释量在30％左右。
+ C3 n  @4 B2 s7 t6 R/ F) i注释语言必须准确、易懂、简洁。
0 k7 G, d: x; Z" a; d9 L0 @8 m" d( Y9 N边写代码边注释，修改代码同时修改相应的注释，不再有用的注释要删除。
汇编和C中都用"//"，取消";"  不使用段注释" /*  */ "（调试时可用）
4 o1 c8 ?; M' `/ O3 O5 E3.2 文件注释
文件注释必须说明文件名、函数功能、创建人、创建日期、版本信息等相关信息。
' H8 k& K" V* P3 {" c, H+ n4 `修改文件代码时，应在文件注释中记录修改日期、修改人员，并简要说明此次修改的目的。所有修改记录必须保持完整。
文件注释放在文件顶端，用"/*……*/"格式包含。
  }+ }: S$ B& F& C1 C$ @! t8 U注释文本每行缩进4个空格；每个注释文本分项名称应对齐。
/***********************************************************
文件名称：
; b- O* O5 w# [9 D' Z作 者：
; w0 p3 r; L4 l/ w) Q" g. s( g+ W4 A版 本：
说 明：
0 B0 m( Z1 E5 ?) u7 i7 @修改记录：
$ M% r! g5 a1 ]***********************************************************/
3.3 函数注释
9 p9 G7 A$ f. N3.3.1 函数头部注释
0 t* m  \& [+ {" n& m函数头部注释应包括函数名称、函数功能、入口参数、出口参数等内容。如有必要还可增加作者、创建日期、修改记录（备注）等相关项目。
函数头部注释放在每个函数的顶端，用"/*……*/"的格式包含。其中函数名称应简写为Name()，不加入、出口参数等信息。
: Z0 R4 G. k0 u3 @) V# u; U. ]0 S/***********************************************************
4 X* r' T  J- w7 g/ @函数名称：
函数功能：
入口参数：
出口参数：
3 t- U/ k, P: c* f备 注：
***********************************************************/
: {. J# \% K  Y# x0 C; k3.3.2 代码注释（信、盈、达‘腾讯：以一齐捂捂吧久零久要’）
$ N( z& H  @8 S代码注释应与被注释的代码紧邻，放在其上方或右方，不可放在下面。如放于上方则需与其上面的代码用空行隔开。一般少量注释应该添加在被注释语句的行2尾，一个函数内的多个注释左对齐；较多注释则应加在上方且注释行与被注释的语句左对齐。
2 Q( m8 d% B, _& v" q函数代码注释用"//…//"的格式。
* I) p& _4 M! M7 v$ n通常，分支语句（条件分支、循环语句等）必须编写注释。其程序块结束行"｝"的右方应加表明该程序块结束的标记"end of ……", 尤其在多重嵌套时。
3.4 变量、常量、宏的注释
同一类型的标识符应集中定义，并在定义之前一行对其共性加以统一注释。对单个标识符的注释加在定义语句的行尾。
全局变量一定要有详细的注释，包括其功能、取值范围、哪些函数或过程存取它以及存取时的注意事项等。
- _& l( G% I3 F8 L7 u! u" r: U" K注释用"//…//"的格式。
8 M# A" I' Z4 W

7 b1 I2 S" A7 y, E% z

liangquan6

不仅单片机，其余机械相关控制程序开发也应该这样编程！

面壁深功

谢谢，先收藏起来

xiaobing86203

单片机的基础知识，值得收藏一波~

武汉老虎

学习了

tainqing

共同学习进步