嵌入式程序编码规范
一、
基本要求
1.程序总体要求
1.1 程序结构清析，简单易懂，单个函数的程序行数不得超过 200 行。
1.2 打算干什么，要简单，直接了当，代码精简，避免垃圾程序。
1.3 尽量使用标准库函数和公共函数。
1.4 不要随意定义全局变量，尽量使用局部变量。
1.5 使用括号以避免二义性。
1.6 单元测试也是编程的一部份，编写程序时，亦必须想好测试的方法。即"单元测试"的
测试方案应在编写程序是一并拟好并提交。
2.可读性要求
2.1 可读性第一，效率第二。
2.2 保持注释与代码完全一致。
2.3 每个源程序文件，都有文件头说明，说明规格见规范。
2.4 每个函数，都有函数头说明，说明规格见规范。
2.5 主要变量（结构、联合、类或对象）定义或引用时，注释能反映其含义。
2.7 常量定义（DEFINE）有相应说明。
2.8 处理过程的每个阶段都有相关注释说明。
2.9 在典型算法前都有注释。
2.10 利用缩进来显示程序的逻辑结构，缩进量一致并以 Tab 键为单位，定义 Tab 为 6 个
字节。
2.11 循环、分支层次不要超过五层。
2.12 注释可以与语句在同一行，也可以在上行。
2.13 空行和空白字符也是一种特殊注释。
2.14 一目了然的语句不加注释。
2.15 注释的作用范围可以为：定义、引用、条件分支以及一段代码。
2.16 注释行数（不包括程序头和函数头说明部份）应占总行数的 1/5 到 1/3 。
3. 结构化要求
3.1 禁止出现两条等价的支路。
3.2 禁止 GOTO 语句。
3.3 用 IF 语句来强调只执行两组语句中的一组。禁止 ELSE GOTO 和 ELSE RETURN。
3.4 用 CASE 实现多路分支。
3.5 避免从循环引出多个出口。
3.6 函数只有一个出口。
3.7 不鼓励使用条件赋值语句。
3.8 避免不必要的分支。
3.9 不要轻易用条件分支去替换逻辑表达式。
4. 正确性与容错性要求
4.1 程序首先是正确，其次是优美
4.2 无法证明你的程序没有错误，因此在编写完一段程序后，应先回头检查。
4.3 改一个错误时可能产生新的错误，因此在修改前首先考虑对其它程序的影响。
4.4 所有变量在调用前必须被初始化。
4.5 对所有的用户输入，必须进行合法性检查。
4.6 不要比较浮点数的相等，
如： 10.0 * 0.1 == 1.0 ， 不可靠
4.7 程序与环境或状态发生关系时，必须主动去处理发生的意外事件，如文件能否
逻辑锁定、打印机是否联机等。
4.9 提交联调测试的程序必须通过单元测试。
5. 可重用性要求
5.1 重复使用的完成相对独立功能的算法或代码应抽象为公共控件或类。
5.2 公共控件或类应考虑 OO 思想，减少外界联系，考虑独立性或封装性。
5.3 公共控件或类应建立使用模板。
二、 编程规则字符串常量符号
1．Goto 语句，尤其是局部的 gotos，是不允许的。
解释：遵循结构化编程规范，使代码更加明白易懂。
2．If 语句的 then 和 else 分支不能为空。
解释：使代码更加明白易懂。
3．在 for、do 和 while 循环中，不提倡使用 break 和 continue 语句。
解释：如同 goto 一样，这些语句破坏了代码的结构化程度，在循环中减少使用将会使代
码更加明白易懂。
4．For 语句中的计数器不应在循环体之中被改变，并且必须是一个局部变量。
解释：减少出错风险且使代码明白易懂。
5．Switch 结构中必须要有 default 语句。
解释：switch 结构中所有类型的 case 分支都要具备（default 也是一种分支）。
6．包含有指令语句的 Case 子句块必须含有 break 语句，且 break 语句为该 case 子句的最后
一条语句。如果 break 不是某 switch 分支的最后一条语句，应增加分支，为每个分支设
置一个 break 语句。
解释：这使得代码更加明白易懂且降低了出错的可能性和风险。
7．如果在某个函数中使用了 return 指令语句，鼓励它是唯一的（即该函数中只能有一个
return 指令），且作为函数的最后一条语句。
解释：只有一个出口的函数更加明白易懂。
8．在 goto 或 return 语句之后不能有不可到达的语句。
解释：原则上，不能有不可到达的代码。如果有，很可能就是逻辑上的错误。
9．禁止对附值语句的值进行测试。
如：if（x=y）{
（y 的值附给了 x，如果 x 的值不为 0，该 if 语句将被执行。）
解释：诸如此类的语句是不明确或不清楚的。或许有人会认为作者的意图是要写
if（x==y）{
最好是将附值语句与 if 语句分开来。
10. 在遍历数组中的连续元素时，应该使用指针，而不是下标。
解释：使代码更高效。
11. 每一个逻辑块应该使用括号括起来，即使它没有语句或只有一条语句。在 switch 语句中
该规则不必适用，因为 case 和 default 语句隔离开了各个逻辑块。
例如：if(x==0){y=1;}
解释：使指令范围更加清楚，代码更易读。
12．每个函数不得有多于 5 个的参数，且所有参数都必须使用。
解释：使代码更易读，防止错误出现。
13．不鼓励在指令块中声明局部变量。
解释：避免到处都是声明，使维护更加容易。
14．全局对象应在一个包含文件中声明。
解释：将声明集中化有利于维护。
15．声明了的变量必须要使用。
解释：使代码更易读、更可靠。
16．声明了的函数必须使用。
解释：防止错误出现。
17．不鼓励使用递归调用，除非算法必须或提高效率的考虑。
解释：使代码更易维护。
18．不能使用全局变量作为函数参数。
解释：保证全局变量的使用都是有意的，即随处可用。
19．一个文件不能有超过三级的包含层次，尽量不超过两层（指头文件）。
解释：使代码更易读。
20．禁止使用诸如 x==y;或 x!=y;的指令语句，它们只应在判断语句中使用。
解释：使代码更可靠。这类指令没有效果，应不被使用。
三、 表达规则
1．每行最多只包含一个声明。
解释：使代码更易读。
2．每一行只能包含一条指令语句。
解释：使代码更易读。
3．边界大括号独占一行。
解释：使程序结构清楚，代码更易读。
4．每个函数的代码不能超过 200 行，每个模块的代码不能超过 2000 行。
解释：使代码更易读。
5．Switch 语句的每一个子句块不能超过 30 条语句。
解释：使代码更易读。
6．C++的关键字不能用做 C 的关键字。
如：class, new, friend,
解释：防止在移植到 C++上时出现混乱。
版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。
发表评论