嵌入式语言工程简明v1

1、C 语言工程简明规范1. 使用编程规范的目的编程规范约定应建立于一项工程之初，且该约定应贯穿整个工程之始终。采用一些规约有助于提高劳动生产率，并使工程便于。用 C 语言或其他语言编写程序的方式有很多种，惯用的，好的书写风格以及他人用的一些好的方法，无非是想力图达到以下的目的：可移植性好；兼容性好；干净整齐；易性好；易看懂；简明扼要；无论采用哪种编程风格，必须在整个工程中采用始终如一的格式。2. 工程组织说明范例工程结构如下图：上图结构详细说明：Component_C, Component_H 两个文件夹用于放置MCU 各模块代码和头文件。Project Settings 为工程文件夹，其下的文

2、件都由 CodeWarrior 自动生成，不建议修改，除非特别需要。Libs 文件夹，主要用于引入库文件。Frame_C, Frame_H 两个文件夹用于放置通用代码文件。比如 type.h 用于类型定义。GeneralFun.c 用于放置一些常用函数等。Isr.h ,isr.c 文件用于处理中断程序。而main.c 为主函数。Include.h为总的头文件。最后一个为工程说明文件。建议在做工程的时候充分利用好这样的一个文件，进行工程开发过程的以及版本升级的。关于构件模块代码的详细说明在范例代码中，每个构件都由一个.c 程序和.h 的头文件。3.头文件包含所有的该构件对外开放的函数接口的及其调

3、用说明。用户只需要查看该头文件就能知道如何调用该模块，那么这个构件就是成功的，用户不需要看具体的函数实现过程。同时，头文件中还可以放置一些与寄存器有关的一些宏定义，这样在主程序中就可以通过宏进行对构件的地址。或者操作，而不需要用户一些繁琐的.c 文件主要是完成对头文件中。的函数的实现。以及一些调用函数的下面给出部分范例代码，加深用户理解:.h 头文件结构如下/* 头部说明，实现功能，构件的一些情况说明 */-*/ 文件名: GPIO.h/ 说 明: GPIO 构件头文件,包含了GeneralFun.h 文件*/-*#ifndef GPIO_H#define GPIO_H/防止重复定义/1 头文

4、件#include MC9S08AW60.h #include Type.h/MC9S08AW60 MCU 映像寄存器名定义/类型别名定义/* 与寄存器有关的部分宏定义 */2.1 AW60 端口 #define PORT_A #define PORT_B #define PORT_C #define PORT_D #define PORT_E #define PORT_F#define PORT_G名与偏移地址的对应关系 024681012 /部分代码已经省略/* 函数接口及其调用说明 */-*/函数名: GPIO_Init*/功/参/返/说能: 初始化GPIO数: port:端口名pin:

5、指定端口引脚direction:引脚方向,0=输入,1=输出s回: 无明: 无e:初始状态,0=低电平,1=高电平/-*void GPIO_Init(u8 port,u8 pin,u8 direction,u8 se); /部分代码已经省略#endif.c 文件结构如下/* 头部说明，实现功能，构件的一些情况说明 */-*/ 文件名: GPIO.c/ 说 明: GPIO 驱动程序文件*/-*#include GPIO.h/包含GPIO 头文件/*调用函数*/ /省略，自己根据需要扩充/* 外部调用函数（即头文件中过的函数）具体实现 */-*/函数名: GPIO_Init/功 能: 初始化GPI

6、O*/参/返/说数: port:端口名 pin:指定端口引脚direction:引脚方向,0=输入,1=输出*s回: 无明: 无e:初始状态,0=低电平,1=高电平/-*void GPIO_Init(u8 port,u8 pin,u8 direction,u8 se)/1.设置引脚方向 if(direction = 1)BSET(PIO_DDR(port);/定义引脚为输出(相应位为 1)elseBCLR(PIO_DDR(port);/定义引脚为输入(相应位为 0)/2.设置引脚状态if(se = 1)BSET(PIO_PORT(port);/输出高电平(1)elseBCLR(PIO_PORT

7、(port);/输出低电平(0) /部分代码省略/*调用函数实现 */ /省略4. C 语言编程规范4.1概述为了提高源程序的质量和可性，从而最终提高产品生产力，特编写此规范。本标准规定了程序设计进行程序设计时必须遵循的规范主要针对单片机编程语言和 08 编译器而言，包括排版、注释、命名、变量使用、代码可测性、程序效率、质量保证等内容。建议在一个工程或者一个项目中尽量遵循相同的代码规范，而不是说你只能拥有一个代码规范。4.2命名规则1）命名基本原则命名清晰明了，有明确含义，使用完整单词或约定俗成的缩写。通常，较短的单词可通过去掉元音字母形成缩写；较长的单词可取单词的头几个字母形成缩写。即见名知

8、意。命名风格要自始至终保持一致。命名中若使用特殊约定或缩写，要有注释说明。为了代码复用，命名中应避免适用与具体项目相关的前缀。应使用英语命名。2）预定义(#define)只使用大写字母，下划线和数字。例如： #defineMAX_LENGTH1宏和常量命名只使用大写字母，下划线和数字。宏和常量用全部大写字母来命名，词与词之间用下划线分隔。对程序中用到的数字均应用有意义的枚举或宏来代替。变量命名变量命名规则： _类型名称。例如：/全局变量g_nMaxCount;/函数体内局部变量MyEnumTypeeParsingMode;局部循环体控制变量优先使用 i、j、k 等；局部长度变量优先使用 len

9、、num 等；临时中间变量优先使用 temp、tmp 等。类型前缀指针（ Poer）p枚举（ Enumeration）e布尔（）b浮点（ Float）f双精度（ Double）d字符（ Char）c结构（ Structure）st其他数字类型, e.g.byte, (unsigned), (unsigned)long, (unsigned)short, (unsigned) short,(unsigned) long longn范围前最结构体的成员变量m_静态变量s_全局变量g_局部变量无前缀结构和类型定义（typedef）按 Camel-Style 方式命名，如ThisIsAnEx枚举leS

10、tructOrEnumOrTyedef 。避免使用下划线。按 CamelStyle 方式命名，如 ThisIsAnExleStructOrEnumOrTyedef 。避免使用下划线。Enum DataSetSeValidModified = 1,InvalidModified = 2,AllDataLoaded = 3函数命名按 CamelStyle 方式命名， ThisIsAnEx文件命名leMethod。一个文件包含一类功能或一个模块的所有函数，文件名称应清楚表明其功能或性质。每个.c 文件应该有一个同名的.h 文件作为头文件。4.3注释注释基本原则有助于对程序的阅读理解，说明程序在做什么

11、，解释代码的目的、功能和采用的方法。一般情况源程序有效注释量在 30左右。 注释语言必须准确、易懂、简洁。边写代码边注释，修改代码同时修改相应的注释，不再有用的注释要删除。 汇编和 C 中都用/，取消;不使用段注释 /* */ （调试时可用）。文件注释文件注释必须说明文件名、项目名称、函数功能、创建人、创建日期、版本信息等相关信息。修改文件代码时，应在文件注释中修改日期、修改，并简明此次修改的目的。所有修改必须保持完整。 文件注在文件顶端，用/*/格式包含。 注释文本每行缩进 4 个空格；每个注释文本分项名称应对齐。/*文件名称：项目名称：作版说者：本：明：修改：*/3）函数注释函数头部注释应

12、包括函数名称、函数功能、参数、出口参数等内容。必要还可增加作者、创建日期、修改（备注）等相关项目。 函数头部注在每个函数的顶端，用/*/的格式包含。其中函数名称应简写为 FunctionName()，不加入、出口参数等信息。/*函数名称：函数功能：参数：出口参数：备 注：*/4）代码注释代码注释应与被注释的代码紧邻，放在其上方或右方，不可放在下面。如放于上方则需与其上面的代码用空行隔开。一般少量注释应该添加在被注释语句的行尾，一个函数内的多个注释左对齐；较多注释则应加在上方且注释行与被注释的语句左对齐。通常，分支语句（条件分支、循环语句等）必须编写注释。其程序块结束行的右方应加表明该程序块结束

13、的标记end of , 尤其在多重嵌套时。例如：/注释 。nNum = 7;/ 注释。for(i = 0 ; I nNum; i+)If( i = = 0)/ codeelse/code /end of if(i = 0) / end of for (i)5）变量、常量、宏的注释同一类型的标识符应集中定义，并在定义之前一行对其共性加以注释。对单个标识符的注释加在定义语句的行尾。 全局变量一定要有详细的注释，包括其功能、取值范围、哪些函数或过程存取它以及存取时的注意事项等。 注释用/的格式。4.4类型别名定义/8 位无符号数/ 16 位无符号数/ 32 位无符号数/8 位有符号数/ 16 位有符

14、号数/ 32 位有符号数typedef unsigned chartypedef unsigned short typedef unsigned long typedef chartypedef short typedef/不优化变量类型uu u8;16;32;8;16;32;/8 位无符号数/ 16 位无符号数/ 32 位无符号数/8 位有符号数/ 16 位有符号数/ 32 位有符号数typedef volatile utypedef volatile u typedef volatile u typedef volatile typedef volatile typedef volatil

15、e81632vuvu vu v v v8;16;32;8;16;32;816324.5编码代码的每一级均往右缩进 4 个空格的位置不使用 Tab 键，建议使用空格代替 tab 键，这样代码打印不回造成错乱。相对独立的程序块之间要加空行括号内侧（即左括号后面和右括号前面）不加空格，多重括号间不加空格。如：SetName(GetFunc()函数形参之间应该有且只有一个空格（形参逗号后面加空格），如：CallFunction(para1, para2, para3)，而CallFunction(para1,para2,para3) 不符合要求。操作符前后均加一个空格，如： nSum = nNunm1 + nNum2 。而 nSum=nNunm1