嵌入式编程规范要点.doc

嵌入式编程规范 1 基本要求 程序结构清晰，简单易懂，单个函数的程序行数不得超过100行，每行代码不得超过100列。 打算干什么，要简单，直接了当，代码精简，避免垃圾程序。 尽量使用标准库函数和公共函数。 不要随意定义全局变量，尽量使用局部变量。 使用括号以避免二义性。 2 可读性要求 可读性第一，效率第二。 保持注释与代码完全一致。 每个源程序文件，都有文件头说明，说明规格见规范。 每个函数，都有函数头说明，说明规格见规范。 主要变量（结构、联合、类或对象）定义或引用时，注释能反映其含义。 常量定义（DEFINE）有相应说明。 处理过程的每个阶段都有相关注释说明。 在典型算法前都有注释。 用缩进来显示程序的逻辑结构，缩进量一致并以Tab键为单位，定义Tab为 4个字节。 循环、分支层次不要超过五层。 注释可以与语句在同一行，也可以在上行。 空行和空白字符也是一种特殊注释。 一目了然的语句不加注释。 注释的作用范围可以为：定义、引用、条件分支以及一段代码。 注释行数（不包括程序头和函数头说明部份）应占总行数的 1/5 到 1/3 。 3 结构化要求 禁止出现两条等价的支路。 禁止GOTO语句。 用 IF 语句来强调只执行两组语句中的一组。禁止 ELSE GOTO 和 ELSE RETURN。 用 CASE 实现多路分支。 避免从循环引出多个出口。 函数只有一个出口。 不使用条