嵌入式C编程规范.docVIP

嵌入式C编程规范 v1.1.1 1 综述 嵌入式工程源文件包括C语言文件（.c、.h）和汇编语言文件，本规范适用于C语言部分。 本规范中，使用3层设计，应用层（Application Layer）、逻辑层（Logic Layer）和驱动层（Driver Layer）。每层由1个或多个模块组成，1个模块对应1个C文件。 驱动层实现底层硬件访问，如控制蜂鸣器响、停； 逻辑层根据应用层的需要，调用驱动层接口，使硬件具有特定的功能，如控制蜂鸣器响5次，每1秒响1次，1次响50毫秒； 应用层调用逻辑层/驱动层接口，实现设备业务流程，如烟火检测器检测到浓烟，拉响警报。 2 分层命名 上图是一个参考结构，目录树反应了程序层次结构。其中app为应用层，logic为逻辑层，driver为驱动层，main.c为程序入口。 根据功能，代码要放在相应的文件夹下。 3 文件/模块 1 源文件、头文件头部进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志，示例如下： ///======================================================================= /// 作者：Pan.wang /// 版本：v1.0 /// summary /// Description /// /summary /// history /// para编号 日期 担当者 更新内容 /para /// para0001 2009/06/03 Pan.wang 编写此模块 /para /// /history ///======================================================================= 说明：Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。History是修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。 2 文件命名：反应模块功能，全用小写，单词之间用_相接，示例如下： stage_wait.c、stage_run.c、key.c、key.h …… 4 函数规范 1 函数头部应进行注释，列出：函数目的/功能、输入、输出参数、返回值，示例如下： /// summary /// 函数功能说明 /// /summary /// param name=sender type=in参量说明/param /// param name=e type=out参量说明/param /// return /// 返回结果说明 /// /return void sprintf(char* pcBufIn, char* pcBufOut) { //Code } 说明：in、out表示输入输出参数。 2 函数命名：全部小写，单词之间用_相接，示例如下： unsigned short get_key_code(); void sci_send_data(unsigned char* pBuf, unsigned int nLen); 3 接口命名：以_开始，后面接所在层名，字母全部小写，单词之间用_相接，示例如下： 层名缩写为：_app、_lgc、_drv _drv_get_key_code(); 5 变量命名 变量命名必须具有一定的实际意义。根据作用域，变量可分为全局变量、局部变量、函数内变量。 函数内变量的格式为：xAbcFgh，x由变量类型确定，Abc、Fgh表示连续意义字符串，如果连续意义字符串仅两个，可都大写，如OK，此规则也使用于参数命名； 局部变量的格式为：m_xAbcFgh，如static bool m_bRunning； 全局变量的格式为：g_xAbcFgh，如unsigned int g_nStage，建议在global.h文件中定义； x表示的变量类型如下表所示： 编号 标记 类型 1 c char 2 uc unsigned char 3 n int 4 un unsigned int 5 s short 6 p 指针/数组 7 l long 8 f float 9 d double 10 t struct 11 o union 12 k 函数指针 13 e enum枚举类型 示例如下： int nTemp; unsigned char ucResult; unsigned char* pucArg; 同时，p/u可以和各种类型灵活组合，如：ul表示unsigned long，uf表示unsigned float等； 6 结构体 结构体类型定义以下划线开始，全部大写字母，结构体变量命名同一般变