嵌入式C语言工程简明规范V1.0(20101026).docx

苏州大学飞思卡尔嵌入式系统研发中心 嵌入式C语言工程简明规范V1.0(2010)(1020)嵌入式C语言工程简明规范1. 使用编程规范的目的编程规范约定应建立于一项工程之初，且该约定应贯穿整个工程之始终。采用一些规约有助于提高劳动生产率，并使工程软件便于维护。用C语言或其他语言编写程序的方式有很多种，惯用的，好的书写风格以及他人用的一些好的方法，无非是想力图达到以下的目的：l 可移植性好；l 兼容性好；l 干净整齐；l 易维护性好；l 易看懂；l 简明扼要；无论采用哪种编程风格，必须在整个工程中采用始终如一的格式。2. 工程组织说明范例工程结构如下图：上图结构详细说明：u Component_C, Component_H 两个文件夹用于放置MCU各模块代码和头文件。u Project Settings为工程文件夹，其下的文件都由CodeWarrior自动生成，不建议修改，除非特别需要。u Libs 文件夹，主要用于引入库文件。 u Frame_C, Frame_H两个文件夹用于放置通用代码文件。比如type.h用于类型定义。GeneralFun.c用于放置一些常用函数等。u Isr.h ,isr.c 文件用于处理中断程序。 而main.c为主函数。 Include.h为总的头文件。u 最后一个为工程说明文件。建议在做工程的时候充分利用好这样的一个文件，进行工程开发过程的记录以及版本升级的记录。3. 关于构件模块代码的详细说明在范例代码中，每个构件都由一个.c程序和.h的头文件。 头文件包含所有的该构件对外开放的函数接口的声明及其调用说明。 用户只需要查看该头文件就能知道如何调用该模块，那么这个构件就是成功的，用户不需要看具体的函数实现过程。同时，头文件中还可以放置一些与寄存器有关的一些宏定义，这样在主程序中就可以通过宏进行对构件的访问或者操作，而不需要用户记忆一些繁琐的地址。.c文件主要是完成对头文件中声明的函数的实现。以及一些内部调用函数的声明和实现。下面给出部分范例代码，加深用户理解:.h头文件结构如下 /* 头部说明，实现功能，构件的一些情况说明 */-*/ 文件名: GPIO.h */ 说 明: GPIO构件头文件,包含了GeneralFun.h文件 */-*#ifndef GPIO_H /防止重复定义#define GPIO_H /1 头文件 #include MC9S08AW60.h /MC9S08AW60 MCU映像寄存器名定义 #include Type.h /类型别名定义 /* 与寄存器有关的部分宏定义 */ /2.1 AW60端口名与偏移地址的对应关系 #define PORT_A 0 #define PORT_B 2 #define PORT_C 4 #define PORT_D 6 #define PORT_E 8 #define PORT_F 10 #define PORT_G 12 /部分代码已经省略 /* 函数接口声明及其调用说明 */ /-* /函数名: GPIO_Init * /功 能: 初始化GPIO * /参 数: port:端口名 * / pin:指定端口引脚 * / direction:引脚方向,0=输入,1=输出 * / state:初始状态,0=低电平,1=高电平 * /返 回: 无 * /说 明: 无 * /-* void GPIO_Init(uint8 port,uint8 pin,uint8 direction,uint8 state); /部分代码已经省略 #endif.c文件结构如下 /* 头部说明，实现功能，构件的一些情况说明 */-*/ 文件名: GPIO.c */ 说 明: GPIO驱动程序文件 */-*#include GPIO.h /包含GPIO头文件/* 内部调用函数声明 */ /省略，自己根据需要扩充/* 外部调用函数（即头文件中声明过的函数）具体实现 */-*/函数名: GPIO_Init */功 能: 初始化GPIO * /参 数: port:端口名 */ pin:指定端口引脚 */ direction:引脚方向,0=输入,1=输出 * / state:初始状态,0=低电平,1=高电平 */返 回: 无 */说 明: 无 */-*void GPIO_Init(uint8 port,uint8 pin,uint8 direction,uint8 state) /1.设置引脚方向 if(direction = 1) BSET(pin,GPIO_DDR(port); /定义引脚为输出(相应位为1) else BCLR(pin,GPIO_DDR(port); /定义引脚为输入(相应位为0) /2.设置引脚状态 if(state = 1) BSET(pin,GPIO_PORT(port); /输出高电平(1) else BCLR(pin,GPIO_PORT(port); /输出低电平(0) /部分代码省略/* 内部调用函数实现 */ /省略4. C语言编程规范4.1概述为了提高源程序的质量和可维护性，从而最终提高软件产品生产力，特编写此规范。本标准规定了程序设计人员进行程序设计时必须遵循的规范。本规范主要针对单片机编程语言和08编译器而言，包括排版、注释、命名、变量使用、代码可测性、程序效率、质量保证等内容。建议在一个工程或者一个项目中尽量遵循相同的代码规范，而不是说你只能拥有一个代码规范。4.2命名规则1）命名基本原则（1）命名清晰明了，有明确含义，使用完整单词或约定俗成的缩写。通常，较短的单词可通过去掉元音字母形成缩写；较长的单词可取单词的头几个字母形成缩写。即见名知意。（2）命名风格要自始至终保持一致。（3）命名中若使用特殊约定或缩写，要有注释说明。（4）为了代码复用，命名中应避免适用与具体项目相关的前缀。（5）应使用英语命名。2）预定义(#define) 只使用大写字母，下划线和数字。例如： #define MAX_LENGTH 13）宏和常量命名只使用大写字母，下划线和数字。宏和常量用全部大写字母来命名，词与词之间用下划线分隔。对程序中用到的数字均应用有意义的枚举或宏来代替。4）变量命名变量命名规则： _类型名称。范围前最结构体的成员变量m_静态变量s_全局变量g_局部变量无前缀类型前缀指针（Pointer）p枚举（Enumeration）e布尔（Boolean） b浮点（Float）f双精度（Double）d字符（Char）c结构（Structure）st其他数字类型, e.g.byte, (unsigned) int, (unsigned)long int, (unsigned)short, (unsigned) short int,(unsigned) long longn例如：/全局变量intg_nMaxCount; /函数体内局部变量MyEnumTypeeParsingMode;局部循环体控制变量优先使用i、j、k等；局部长度变量优先使用len、num等；临时中间变量优先使用temp、tmp等。5）结构和类型定义（typedef）按Camel-Style方式命名，如ThisIsAnExampleStructOrEnumOrTyedef 。避免使用下划线。6）枚举按Camel-Style方式命名，如ThisIsAnExampleStructOrEnumOrTyedef 。避免使用下划线。Enum DataSetStateValidModified = 1,InvalidModified = 2,AllDataLoaded = 37）函数命名按Camel-Style方式命名， ThisIsAnExampleMethod。8）文件命名一个文件包含一类功能或一个模块的所有函数，文件名称应清楚表明其功能或性质。 每个.c文件应该有一个同名的.h文件作为头文件。4.3注释1）注释基本原则 有助于对程序的阅读理解，说明程序在做什么，解释代码的目的、功能和采用的方法。一般情况源程序有效注释量在30左右。 注释语言必须准确、易懂、简洁。边写代码边注释，修改代码同时修改相应的注释，不再有用的注释要删除。 汇编和C中都用/，取消; 不使用段注释 /* */ （调试时可用）。2）文件注释 文件注释必须说明文件名、项目名称、函数功能、创建人、创建日期、版本信息等相关信息。修改文件代码时，应在文件注释中记录修改日期、修改人员，并简要说明此次修改的目的。所有修改记录必须保持完整。 文件注释放在文件顶端，用/*/格式包含。 注释文本每行缩进4个空格；每个注释文本分项名称应对齐。 /*- 文件名称：项目名称：作 者： 版 本： 说 明： 修改记录： -*/ 3）函数注释函数头部注释应包括函数名称、函数功能、入口参数、出口参数等内容。如有必要还可增加作者、创建日期、修改记录（备注）等相关项目。 函数头部注释放在每个函数的顶端，用/*/的格式包含。其中函数名称应简写为FunctionName()，不加入、出口参数等信息。 /*- 函数名称： 函数功能： 入口参数： 出口参数： 备 注： -*/ 4）代码注释 代码注释应与被注释的代码紧邻，放在其上方或右方，不可放在下面。如放于上方则需与其上面的代码用空行隔开。一般少量注释应该添加在被注释语句的行尾，一个函数内的多个注释左对齐；较多注释则应加在上方且注释行与被注释的语句左对齐。通常，分支语句（条件分支、循环语句等）必须编写注释。其程序块结束行的右方应加表明该程序块结束的标记end of , 尤其在多重嵌套时。例如：int nNum = 7; / 注释 。/ 注释。for(int i = 0 ; I nNum; i+) If( i = = 0)/ codeelse /code /end of if(i = 0) / end of for (i)5）变量、常量、宏的注释 同一类型的标识符应集中定义，并在定义之前一行对其共性加以统一注释。对单个标识符的注释加在定义语句的行尾。 全局变量一定要有详细的注释，包括其功能、取值范围、哪些函数或过程存取它以及存取时的注意事项等。 注释用/的格式。4.4统一类型别名定义typedef unsigned char uint8; / 8 位无符号数typedef unsigned short int uint16; / 16 位无符号数typedef unsigned long int uint32; / 32 位无符号数typedef char int8; / 8 位有符号数typedef short int int16; / 16 位有符号数 typedef int int32; / 32 位有符号数/不优化变量类型typedef volatile uint8 vuint8; / 8 位无符号数 typedef volatile uint16 vuint16; / 16 位无符号数 typedef volatile uint32 vuint32; / 32 位无符号数 typedef volatile int8 vint8; / 8 位有符号数 typedef volatile int16 vint16; / 16 位有符号数 typedef volatile int32 vint32; / 32 位有符号数 4.5编码 代码的每一级均往右缩进4个空格的位置 不使用Tab键，建议使用空格代替tab键，这样代码打印不回造成错乱。 相对独立的程序块之间要加空行 括号内侧（即左括号后面和右括号前面）不加空格，多重括号间不加空格。如：SetName(GetFunc() 函数形参之间应该有且只有一个空格（形参逗号后面加空格），如：CallFunction(para1, para2, para3)，而CallFunction(para1,para2,para3) 不符合要求。 操作符前后均加一个空格，如： nSum = nNunm1 + nNu