1、嵌入式编程规范1 基本要求1) 程序结构清晰，简单易懂，单个函数的程序行数不得超过 100 行，每行代码不得超过 100 列。2) 打算干什么，要简单，直接了当，代码精简，避免垃圾程序。3) 尽量使用标准库函数和公共函数。4) 不要随意定义全局变量，尽量使用局部变量。5) 使用括号以避免二义性。 2 可读性要求1) 可读性第一，效率第二。2) 保持注释与代码完全一致。3) 每个源程序文件，都有文件头说明，说明规格见规范。4) 每个函数，都有函数头说明，说明规格见规范。5) 主要变量（结构、联合、类或对象）定义或引用时，注释能反映其含义。6) 常量定义（DEFINE ）有相应说明。7) 处理过程
2、的每个阶段都有相关注释说明。8) 在典型算法前都有注释。9) 用缩进来显示程序的逻辑结构，缩进量一致并以 Tab 键为单位，定义 Tab 为 4 个字节。10) 循环、分支层次不要超过五层。11) 注释可以与语句在同一行，也可以在上行。12) 空行和空白字符也是一种特殊注释。13) 一目了然的语句不加注释。14) 注释的作用范围可以为：定义、引用、条件分支以及一段代码。15) 注释行数（不包括程序头和函数头说明部份）应占总行数的 1/5 到 1/3 。3 结构化要求1) 禁止出现两条等价的支路。2) 禁止 GOTO 语句。3) 用 IF 语句来强调只执行两组语句中的一组。禁止 ELSE GOT
3、O 和 ELSE RETURN。4) 用 CASE 实现多路分支。5) 避免从循环引出多个出口。6) 函数只有一个出口。7) 不使用条件赋值语句。8) 避免不必要的分支。9) 不要轻易用条件分支去替换逻辑表达式。4 正确性与容错性要求1) 程序首先是正确，其次是优美。2) 无法证明你的程序没有错误，因此在编写完一段程序后，应先回头检查。3) 改一个错误时可能产生新的错误，因此在修改前首先考虑对其它程序的影响。4) 所有变量在调用前必须被初始化。5) 对所有的用户输入，必须进行合法性检查。6) 不要比较浮点数的相等，如： 10.0 * 0.1 = 1.0 ， 不可靠7) 程序与环境或状态发生关系
4、时，必须主动去处理发生的意外事件，如文件能否逻辑锁定、打印机是否联机等。8) 单元测试也是编程的一部份，提交联调测试的程序必须通过单元测试。5 可重用性要求1) 重复使用的完成相对独立功能的算法或代码应抽象为公共控件或类。2) 公共控件或类应考虑 OO 思想，减少外界联系，考虑独立性或封装性。3) 公共控件或类应建立使用模板。6 编码具体规范6. 1 排版 程序块要采用缩进风格编写（1）缩进的空格数为 4 个。（2）函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case 语句下的情况处理语句也要遵从语句缩进要求。示例：int delch(char str , char
5、 c) int i, j;for (i = j = 0; stri != 0 i+) if (stri != c)strj+ = stri;strj = 0 （3）在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、 do、while、switch、case 语句中的程序都要采用如上的缩进方式。 大括号和的使用（1）程序块的分界符（如 C/C+语言的大括号 和 ）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。示例：如下例子不符合规范。for (.) . /* program code */if (.) . /* program code */void example_f
6、un( void ). /* program code */应如下书写。for (.) . /* program code */if (.) . /* program code */void example_fun( void ). /* program code */（2）if、for、do、while、case、switch、default 等语句自占一行，且if、for、 do、while 等语句的执行语句部分无论多少都要加括号 。 示例：如下例子不符合规范。if (pUserCR = NULL) return;应如下书写：if (pUserCR = NULL)return; 在两个以上
7、的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如） ，后不应加空格。说明：采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧(即左括号后面和右括号前面) 不需要加空格，多重括号间不必加空格，因为在 C 语言中括号已经是最清晰的标志了。在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。示例：(1) 逗号、分号只在后面加空格。int a, b, c;
8、 (2) 比较操作符 , 赋值操作符“=“、 “+=“，算术操作符“+“ 、“%“，逻辑操作符“a *= 2;a = b 2;(3) “!“、“ 、“+“、“-“ 、“ /* 非操作“!“ 与内容之间 */p = /* 地址操作“ /* “+“,“-“与内容之间 */(4) “-“、“.“前后不加空格。p-id = pid; /* “-“指针前后不加空格 */(5) if、for、 while、switch 等与后面的括号间应加空格，使 if 等关键字更为突出、明显。if (a = b parent-p_datai.a.bj-1.f2=0;parent-p_datai.a.bj-1.f3=0;
9、parent-p_datai.a.bj-1.f4=0;parent-p_datai.a.bj-1.f5=0;parent-p_datai.a.bj-1.f6=0;parent-p_datai.a.bj-1.f7=0;parent-p_datai.a.bj-1.f8=0; 假定 b 的结构为 struct B, 则可改写为：struct B *b=b-f1=0;b-f2=0;b-f3=0;b-f4=0;b-f5=0;b-f6=0;b-f7=0;b-f8=0;6. 5 函数、过程建议 5-1：一个函数仅完成一件功能。建议 5-2：为简单功能编写函数。说明：虽然为仅用一两行就可完成的功能去编函数好象
10、没有必要，但用函数可使功能明确化，增加程序可读性，亦可方便维护、测试。示例：如下语句的功能不很明显。value = ( a b ) ? a : b ;改为如下就很清晰了。int max (int a, int b)return (a b) ? a : b);value = max (a, b);或改为如下。#define MAX (a, b) (a) (b) ? (a) : (b)value = MAX (a, b);建议 5-3：不要设计多用途面面俱到的函数。说明：多功能集于一身的函数，很可能使函数的理解、测试、维护等变得困难。建议 5-4：函数名应准确描述函数的功能。使用动宾词组为执行某操
11、作的函数命名。如果是 OOP 方法，可以只有动词（名词是对象本身） 。示例：参照如下方式命名函数。void printRecord( unsigned int rec_ind ) ;int inputRecord( void ) ;unsigned char getCrrentColor( void ) ;建议 5-5：函数的返回值要清楚、明了，让使用者不容易忽视错误情况。说明：函数的每种出错返回值的意义要清晰、明了、准确，防止使用者误用、理解错误或忽视错误返回码。6. 6 命名规则1) 函数名：首单词字母全部小写，后面代表独立意思的单词首字母大写，后面的字母小写。如：sendMsgFlg（）
12、 ；2) 变量名： 全局变量命名规则：int g_maxCycle;char *p_strName;局部变量命名规则int max_cycle;3) 文件名全部小写，如：cdatamng.h ；6.7 函数返回值的处理1) 函数返回值类型是 void 时，不作要求；2) 函数返回值类型是 BOOL 类型时，则要求返回 TRUE（正确） 、FALSE（失败） 。同时，要求统一定义宏 TRUE（1） 、FALSE（0） ；3) 函数返回值类型是 int 类型时，如果返回值只表示成功或失败时，则要求返回0（正确） 、-1（失败） 。如果返回值表示成功或多种失败原因中的某一种时，则要求返回 0（正确） 、ErrNo （大于 0 的整数，表示错误类型编码） 。4) 函数返回值类型是浮点数时，不作要求；6.8 变量的定义方式1) 全局变量一般定义在文件第一个函数的前面。2) 局部变量一般在进入函数后立即定义，请勿在函数中间定义。
