嵌入式编程规范解析.docx

嵌入式编程规范解析.docx

《嵌入式编程规范解析.docx》由会员分享，可在线阅读，更多相关《嵌入式编程规范解析.docx（15页珍藏版）》请在冰豆网上搜索。

嵌入式编程规范解析

嵌入式编程规范

1基本要求

1）程序结构清晰，简单易懂，单个函数的程序行数不得超过100行，每行代码不得超过100列。

2）打算干什么，要简单，直接了当，代码精简，避免垃圾程序。

3）尽量使用标准库函数和公共函数。

4）不要随意定义全局变量，尽量使用局部变量。

5）使用括号以避免二义性。

2可读性要求

1）可读性第一，效率第二。

2）保持注释与代码完全一致。

3）每个源程序文件，都有文件头说明，说明规格见规范。

4）每个函数，都有函数头说明，说明规格见规范。

5）主要变量（结构、联合、类或对象）定义或引用时，注释能反映其含义。

6）常量定义（DEFINE）有相应说明。

7）处理过程的每个阶段都有相关注释说明。

8）在典型算法前都有注释。

9）用缩进来显示程序的逻辑结构，缩进量一致并以Tab键为单位，定义Tab为4个字节。

10）循环、分支层次不要超过五层。

11）注释可以与语句在同一行，也可以在上行。

12）空行和空白字符也是一种特殊注释。

13）一目了然的语句不加注释。

14）注释的作用范围可以为：

定义、引用、条件分支以及一段代码。

15）注释行数（不包括程序头和函数头说明部份）应占总行数的1/5到1/3。

3结构化要求

1）禁止出现两条等价的支路。

2）禁止GOTO语句。

3）用IF语句来强调只执行两组语句中的一组。

禁止ELSEGOTO和ELSERETURN。

4）用CASE实现多路分支。

5）避免从循环引出多个出口。

6）函数只有一个出口。

7）不使用条件赋值语句。

8）避免不必要的分支。

9）不要轻易用条件分支去替换逻辑表达式。

4正确性与容错性要求

1）程序首先是正确，其次是优美。

2）无法证明你的程序没有错误，因此在编写完一段程序后，应先回头检查。

3）改一个错误时可能产生新的错误，因此在修改前首先考虑对其它程序的影响。

4）所有变量在调用前必须被初始化。

5）对所有的用户输入，必须进行合法性检查。

6）不要比较浮点数的相等，如：

10.0*0.1==1.0，不可靠

7）程序与环境或状态发生关系时，必须主动去处理发生的意外事件，如文件能否逻辑锁定、打印机是否联机等。

8）单元测试也是编程的一部份，提交联调测试的程序必须通过单元测试。

5可重用性要求

1）重复使用的完成相对独立功能的算法或代码应抽象为公共控件或类。

2）公共控件或类应考虑OO思想，减少外界联系，考虑独立性或封装性。

3）公共控件或类应建立使用模板。

6编码具体规范

6.1排版

●程序块要采用缩进风格编写

（1）缩进的空格数为4个。

（2）函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case语句下的情况处理语句也要遵从语句缩进要求。

示例：

intdelch（charstr[],charc）

{

inti,j;

for（i=j=0;str[i]!

=''\0'i++）

{

if（str[i]!

=c）

str[j++]=str[i];

}

str[j]=''\0'

}

（3）在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。

●大括号‘{’和‘}’的使用

（1）程序块的分界符（如C/C++语言的大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。

示例：

如下例子不符合规范。

for（...）{

.../*programcode*/

}

if（...）

{

.../*programcode*/

}

voidexample_fun（void）

{

.../*programcode*/

}

应如下书写。

for（...）

{

.../*programcode*/

}

if（...）

{

.../*programcode*/

}

voidexample_fun（void）

{

.../*programcode*/

}

（2）if、for、do、while、case、switch、default等语句自占一行，且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。

示例：

如下例子不符合规范。

if（pUserCR==NULL）return;

应如下书写：

if（pUserCR==NULL）

{

return;

}

●在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如－>），后不应加空格。

说明：

采用这种松散方式编写代码的目的是使代码更加清晰。

由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧（即左括号后面和右括号前面）不需要加空格，多重括号间不必加空格，因为在C语言中括号已经是最清晰的标志了。

在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。

给操作符留空格时不要连续留两个以上空格。

示例：

（1）逗号、分号只在后面加空格。

inta,b,c;

（2）比较操作符,赋值操作符"="、"+="，算术操作符"+"、"%"，逻辑操作符"&&"、"&"，位运算符"<<"、"^"等双目操作符的前后加空格。

if（current_time>=MAX_TIME_VALUE）

a=b+c;

a*=2;

a=b^2;

（3）"!

"、"~"、"++"、"--"、"&"（地址运算符）等单目操作符前后不加空格。

*p=''a'/*内容操作"*"与内容之间*/

flag=!

isEmpty;/*非操作"!

"与内容之间*/

p=&mem;/*地址操作"&"与内容之间*/

i++;/*"++","--"与内容之间*/

（4）"->"、"."前后不加空格。

p->id=pid;/*"->"指针前后不加空格*/

（5）if、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显。

if（a>=b&&c>d）

●较长语句与表达式的书写处理方法

（1）较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。

示例：

report_or_not_flag=（（taskno

&&（n7stat_stat_item_valid（stat_item））

&&（act_task_table[taskno].result_data!

=0））;

（2）循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。

示例：

for（i=0,j=0;

（i

i++,j++）

{

...//programcode

}

（3）若函数或过程中的参数较长，则要进行适当的划分。

建议：

一行程序以小于80字符为宜，不要写得过长。

●不允许把多个短语句写在一行中，即一行只写一条语句。

示例：

如下例子不符合规范。

length=0;width=0;

应如下书写

length=0;

width=0;

●相对独立的程序块之间、变量说明之后必须加空行。

示例：

如下例子不符合规范。

if（!

valid_ni（ni））

{

...//programcode

}

repssn_ind=ssn_data[index].repssn_index;

repssn_ni=ssn_data[index].ni;

6.2注释

●注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面。

示例：

如下例子不符合规范。

/*getreplicatesubsystemindexandnetindicator*/

repssn_ind=ssn_data[index].repssn_index;

repssn_ni=ssn_data[index].ni;

●将注释与其上面的代码用空行隔开。

示例：

如下例子，显得代码过于紧凑。

/*codeonecomments*/

programcodeone

/*codetwocomments*/

programcodetwo

应如下书写

/*codeonecomments*/

programcodeone

/*codetwocomments*/

programcodetwo

●注释与所描述内容进行同样的缩排。

说明：

可使程序排版整齐，并方便注释的阅读与理解。

示例：

如下例子，排版不整齐，阅读稍感不方便。

voidexample_fun（void）

{

/*codeonecomments*/

CodeBlockOne

/*codetwocomments*/

CodeBlockTwo

}

应改为如下布局。

voidexampleFun（void）

{

/*codeonecomments*/

CodeBlockOne

/*codetwocomments*/

CodeBlockTwo

}

6.3标识符命名

●标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。

说明：

较短的单词可通过去掉“元音”形成缩写；较长的单词可取单词的头几个字母形成缩写；一些单词有大家公认的缩写。

示例：

如下单词的缩写能够被大家基本认可。

temp可缩写为tmp;

flag可缩写为flg;

statistic可缩写为stat;

increment可缩写为inc;

message可缩写为msg;

●命名中若使用特殊约定或缩写，则要有注释说明。

说明：

应该在源文件的开始之处，对文件中所使用的缩写或约定，特别是特殊的缩写，进行必要的注释说明。

●对于变量命名，尽量不选用单个字符（如i、j、k...），建议除了要有具体含义外，还能表明其变量类型、数据类型等，但i、j、k作局部循环变量是允许的。

说明：

变量，尤其是局部变量，如果用单个字符表示，很容易敲错（如i写成j），而编译时又检查不出来，有可能为了这个小小的错误而花费大量的查错时间。

示例：

下面所示的局部变量名的定义方法可以借鉴。

intliv_Width

其变量名解释如下：

l局部变量（Local）（其它：

g全局变量（Global）...）

i数据类型（Interger）

v变量（Variable）（其它：

c常量（Const）...）

Width变量含义

这样可以防止局部变量与全局变量重名。

建议3-2：

用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。

说明：

下面是一些在软件中常用的反义词组。

add/removebegin/endcreate/destroy

insert/deletefirst/lastget/release

increment/decrementput/get

add/deletelock/unlockopen/close

min/maxold/newstart/stop

next/previoussource/targetshow/hide

send/receivesource/destination

cut/pasteup/down

示例：

intmin_sum;

intmax_sum;

6.4可读性

●注意运算符的优先级，并用括号明确表达式的操作顺序，避免使用默认优先级。

说明：

防止阅读程序时产生误解，防止因默认的优先级与设计思想不符而导致程序出错。

示例：

下列语句中的表达式

word=（high<<8）|low

（1）

if（（a|b）&&（a&c））

（2）

if（（a|b）<（c&d））（3）

如果书写为

high<<8|low

a|b&&a&c

a|b

由于

high<<8|low=（high<<8）|low,

a|b&&a&c=（a|b）&&（a&c），

（1）

（2）不会出错，但语句不易理解；

a|b

●避免使用不易理解的数字，用有意义的标识来替代。

涉及物理状态或者含有物理意义的常量，不应直接使用数字，必须用有意义的枚举或宏来代替。

示例：

如下的程序可读性差。

if（Trunk[index].trunk_state==0）

{

Trunk[index].trunk_state=1;

...//programcode

}

应改为如下形式。

#defineTRUNK_IDLE0

#defineTRUNK_BUSY1

if（Trunk[index].trunk_state==TRUNK_IDLE）

{

Trunk[index].trunk_state=TRUNK_BUSY;

...//programcode

}

建议4-1：

不要使用难懂的技巧性很高的语句，除非很有必要时。

说明：

高技巧语句不等于高效率的程序，实际上程序的效率关键在于算法。

示例：

如下表达式，考虑不周就可能出问题，也较难理解。

*stat_poi+++=1;

*++stat_poi+=1;

应分别改为如下。

*stat_poi+=1;

stat_poi++;//此二语句功能相当于“*stat_poi+++=1;”

++stat_poi;

*stat_poi+=1;//此二语句功能相当于“*++stat_poi+=1;”

●避免使用多层次的指针、结构体访问

parent->p_data[i].a.b[j-1].f1=0;

parent->p_data[i].a.b[j-1].f2=0;

parent->p_data[i].a.b[j-1].f3=0;

parent->p_data[i].a.b[j-1].f4=0;

parent->p_data[i].a.b[j-1].f5=0;

parent->p_data[i].a.b[j-1].f6=0;

parent->p_data[i].a.b[j-1].f7=0;

parent->p_data[i].a.b[j-1].f8=0;

假定b的结构为structB,则可改写为：

structB*b=&（parent->p_data[i].a.b[j-1]）;

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：

为简单功能编写函数。

说明：

虽然为仅用一两行就可完成的功能去编函数好象没有必要，但用函数可使功能明确化，增加程序可读性，亦可方便维护、测试。

示例：

如下语句的功能不很明显。

value=（a>b）?

a:

b;

改为如下就很清晰了。

intmax（inta,intb）

{

return（（a>b）?

a:

b）;

}

value=max（a,b）;

或改为如下。

#defineMAX（a,b）（（（a）>（b））?

（a）:

（b））

value=MAX（a,b）;

建议5-3：

不要设计多用途面面俱到的函数。

说明：

多功能集于一身的函数，很可能使函数的理解、测试、维护等变得困难。

建议5-4：

函数名应准确描述函数的功能。

使用动宾词组为执行某操作的函数命名。

如果是OOP方法，可以只有动词（名词是对象本身）。

示例：

参照如下方式命名函数。

voidprintRecord（unsignedintrec_ind）;

intinputRecord（void）;

unsignedchargetCrrentColor（void）;

建议5-5：

函数的返回值要清楚、明了，让使用者不容易忽视错误情况。

说明：

函数的每种出错返回值的意义要清晰、明了、准确，防止使用者误用、理解错误或忽视错误返回码。

6.6命名规则

1）函数名：

首单词字母全部小写，后面代表独立意思的单词首字母大写，后面的字母小写。

如：

sendMsgFlg（）；

2）变量名：

全局变量命名规则：

intg_maxCycle;

char*p_strName;

局部变量命名规则

intmax_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）局部变量一般在进入函数后立即定义，请勿在函数中间定义。