C编程规范_嵌入式_Rev_1_04.pdf

《C编程规范_嵌入式_Rev_1_04.pdf》由会员分享，可在线阅读，更多相关《C编程规范_嵌入式_Rev_1_04.pdf（8页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、 C 编 程 规 范 C 编 程 规 范（嵌入式系统部分）（嵌入式系统部分）蒋辉杰 编 蒋辉杰 编 二零零五二零零五 年年 二二 月月 二十一二十一 日日 目目 录录 1 本规范内容.1 2 符号命名规则.1 3 数据说明.2 3.1 数据说明次序.2 3.2 数据类型.2 4 程序注释.3 4.1 文件注释.3 4.2 函数注释.4 4.3 变量注释.4 4.4 功能块注释.4 5 语句结构.5 5.1 缩进.5 5.2 空格.5 5.3 换行.5 5.4 空行.5 5.5 对齐.6 6 举例.6 7 关于MISRA.6 嵌入式系统 C 编程规范-1-C 编程规范编程规范 1 本规范内容本规

2、范内容 本规范适用于采用基于 C 语言的嵌入式系统编程。本规范约定如下内容：1)符号命名规则 2)数据说明 3)程序注释 4)语句结构 2 符号命名规则符号命名规则 符号名包括模块名、常量名、标号名、函数名等。这些名字应该能反映它所代表的实际对象，具有一定的意义，使其能够见名知义，有助于对程序功能的理解。命名使用英文，不允许使用拼音，命名采用匈牙利命名法，规则如下：(1)所有宏定义、枚举常数和 const 变量，用大写字母命名，在复合词里用下划线隔开每个词（所有其它情况不允许使用下划线）；(2)复合词中每个单词的第一个字母大写；(3)类、类型定义和枚举型名的第一个字母大写；(4)函数名是复合词

3、的，每个单词采用第一个字母大写，其它字母小写方式；(5)函数和常量命名以所在文件的文件名（或其缩写）打头；(6)循环变量可采用 i,j,k 等，不受上述规则限制；(7)全局变量词头为 g；(8)临时变量词头为 tmp；(9)对结构体内的变量命名,同普通变量命名法则；(10)结构体类型头为 t，变量名除了指针“p”、全局变量“g”外，不加前缀；(11)用小写字母的前缀表示变量的类型，前缀的下一个字母用大写。名字的长度一般不要过长或过短，约定长度范围：3-31。C 编程规范 嵌入式系统-2-表 1 变量命名法 表 1 变量命名法 前缀 意义 举例 备注 p Pointer Finger*pRude

4、;大多数情况下 p 和其它前缀一起用如：String*psName;s str String String sName;String strName;sz psz zero-terminated/null-terminated string char szName16;char*pszName;h Handle HWND hWindow c Character(char)char cLetter;n Integer(int)int nSizeOfArray;f Float float fRootBeer;d Double double dDecker;b Boolean boolean bIs

5、True;BOOL bIsTrue;int bIsTrue;u Unsigned.w Word or Unsigned Integer unsigned int wValue;l Long long lIdentifier;dw Unsigned Long Integer g Global String*gpsBuffer t Struct tStruct Struct tStruct*pStruct s Short int Short int sValue 3 数据说明数据说明 3.1 数据说明次序数据说明次序 数据说明次序应当规范化，使数据属性容易查找，也有利于测试、排错和维护。说明的先后

6、次序应固定，应按逻辑功能排序，逻辑功能块内建议采用下列顺序：整型说明、实型说明、字符说明、逻辑量说明。3.2 数据类型数据类型 尽量使用 typedef 来规定变量的类型。嵌入式系统 C 编程规范-3-不得使用 char,int,float,double,long 等基本类型，应该用自己定义的类型显示表示类型的大小，如 CHAR8,UCHAR8,INT16,UINT16,INT32,UINT32,FLOAT32,LONG64,ULONG64 等。4 程序注释程序注释 程序注释分为文件注释、函数注释、变量的注释和功能块注释。注释一律使用块注释（“/*/”）。4.1 文件注释文件注释 文件注释位于

7、程序开头。包括：文件、建立日期、修改日期、创建人、版权、版本和说明。格式如下：/*文件：FileName.c *建立日期:2005-1-25 *修改日期:2005-2-18 *创建人:姓名 *版权:版权 *版本:1.01(Initial Release)*说明：*晶振频率：20MHz */（空两行，开始程序正文）文件：文件的名称；建立日期：建立该程序的日期；C 编程规范 嵌入式系统-4-修改日期：最后修改该程序的日期；创建人：创建该程序的程序员；版权：源程序的归属；版本：1.ab，其中 ab 为 0199，b 为奇数为测试版，b 为偶数为正式版；说明：对程序的功能进行说明。4.2 函数注释函数

8、注释 函数注释位于函数开头。包括：函数名、建立日期、修改日期、作者、参数和功能描述。格式如下：/*函数名：funcName()*建立日期:2005-1-25 *修改日期:2005-2-18 *作者:姓名 *参数：类型 参数名 输入/输出：说明 *功能描述：*/（空一行，开始函数正文）（函数结束空两行）4.3 变量注释变量注释 在变量定义的时候对其含义注释。4.4 功能块注释功能块注释 功能性注释嵌在源程序体中，用于描述其后的语句或程序段做什么工作，也就是解释嵌入式系统 C 编程规范-5-下面要做什么，或是执行了下面的语句会怎么样，而不要解释下面怎么做。5 语句结构语句结构 为保证程序的可读性，

9、应该注意“缩进、空格、换行、空行、对齐”的适当应用。5.1 缩进缩进 缩进的量为一个 TAB 键（4 个空格）。“”的使用采用独占一行的风格，和块的最前端对齐。5.2 空格空格 在运算符前后加空格(+，-除外)，诸如 if()、for()等括号内不用空格。5.3 换行换行 一行一条语句；多参数时候，一行一个参数；OpenTimer1(T1_ON&/*开启 Timer1 */T1_IDLE_CON&/*Idel 时候 Timer1 继续工作 */T1_GATE_OFF&/*关闭 TGATE */T1_PS_1_1&/*预分频器分频比为 1:1 */T1_SYNC_EXT_OFF&/*不与外部时钟

10、同步 */T1_SOURCE_INT,/*使用内部时钟(Fosc/4)*/dT1Period /*装载 Timer1 Period 值 */);条件语句也应该在必要时换行。if(ch=0|ch=a|ch=A|ch=Z)5.4 空行空行 程序块间加空行，以区分程序功能块。C 编程规范 嵌入式系统-6-5.5 对齐对齐 同一功能块中对其“=”。6 举例举例 void _attribute_(_interrupt_)_T1Interrupt(void)IFS0bits.T1IF=0;/*清除 Timer1 中断标志位 */*50ms 定时器 */if(!(unCpuGlintTimer-)/*CPU

11、 灯闪烁定时器定时到 */unCpuGlintTimer =CPU_GLINT_TIMER;/*CPU 灯闪烁定时器赋初值 */uGF.cpuGlint =1;/*置 CPU_LED 闪烁标志位 */*CPU 灯闪烁 */if(uGF.cpuGlint)uGF.CpuGlint =0;/*清除 CPU_LED 闪烁标志位 */if(CpuLED_ON)/*CPU_LED 闪烁 */CpuLED_ON=0;else CpuLED_ON=1;return;7 关于关于 MISRA 尽量使用 MISRA（The Motor Industry Software Reliability Association 汽车工业软件可靠性联会）C 编程规范。