嵌入式软件编程规范.docx

嵌入式软件编程规范.docx

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

嵌入式软件编程规范

TRZN嵌入式软件编程规范

文档修改历史：

版本号

日期

修改者及常用邮箱

修改日志

0.1

2016-10-28

杨科

ykee

根据查阅的相关资料整理，此版本为第一次提交。

1文档概述

1.1关于本文档

本文档规范了芜湖天人智能有限公司嵌入式软件部软件代码的书写规范和原则。

本文档仅供公司内部员工使用。

公司机密，严禁外传。

本文档中各规则的格式如下：

【规则编号】[规则内容][[标记]]

其中[标记]的含义如下：

（必须）：

表示该条规则是必须遵守的。

（建议）：

表示该条规则是建议遵守的。

（可选）或没有标记：

表示该条规则是可选择遵守的。

本文档的示例中，如有使用“//”，并非代码注释，而是文档的注释（有可能是文档中对代码注释的解释）。

1.2参考文献

[1]高质量C++编程

[2]EffectiveC++

[3]MoreEffectiveC++

[4]C++Primer

[5]ThinkinginC++

2排版

●【规则21】程序块要采用缩进风格编写，缩进的空格数为4个,对齐使用空格键，不得使用TAB键。

[必须]

嵌入式软件开发的代码编辑器，推荐使用KeiluVision5，编辑器参数设置见附录A。

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

[必须]

示例：

不正确的书写方式：

if（!

rpr_valid_ni（ni））

{

...//programcode

}

gRprRepssnInd

=gRprSsnData[idx].repssn_index;

gRprRepssnNi=gRprSsnData[idx].ni;

正确的书写方式:

if（!

rpr_valid_ni（ni））

{

...//programcode

}

//空行

gRprRepssnInd

=gRprSsnData[idx].repssn_index;

gRprRepssnNi=gRprSsnData[idx].ni;

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

[必须]

示例：

gRprPermCountMsg.head.len=RPR_NO7_TO_STAT_PERM_COUNT_LEN+

RPR_STAT_SIZE_PER_FRAM*sizeof（UINT32）;

gSysAcbTaskTable[frame_id*RPR_STAT_TASK_CHECK_NUMBER+index].nOccupied=

rprStatPoi[index].nOccupied;

gSysAcbTaskTable[taskno].nDurationTrueOrFalse=

SYS_getSccpStatisticState（statItem）;

gRprReportOrNotFlag=（（SYS_MAX_ACT_TASK_NUMBER>taskno）&&

（SYS_n7statStatItemValid（statItem））&&

（0!

=gSYSActTaskTable[taskno].resultData））;

●【规则24】循环、判断等语句中若有较长的表达式或语句，则要进行适当的分行，长表达式要在低优先级操作符处划分新行，操作符放在行尾。

[必须]

示例：

if（（taskno

（SYS_n7statStatItemValid（statItem）））

{

...//programcode

}

//空行

for（i=0,j=0;

（i

（j

{

...//programcode

}

//空行

for（i=0,j=0;

（i

i++,j++）

{

...//programcode

}

●【规则25】若函数的参数较长，则要进行适当的分行。

[必须]

示例：

rpr_n7statStrCompare（（UINT8*）&statObject,

（UINT8*）&（gSysActTaskTable[taskno].statObject）,

sizeof（SYS_STAT_OBJECT））;

rpr_n7statFlashActDuration（statItem,frameId*SYS_STAT_TASK_CHECK_NUMBER

+index,statObject）;

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

[必须]

示例：

不正确的书写方式：

rect.nLength=0;rect.nWidth=0;

正确的书写方式：

rect.nLength=0;

rect.nWidth=0;

●【规则27】if、for、do、while、case、switch、default等语句自占一行，且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。

[必须]

示例：

不正确的书写方式：

if（pUserCR==NULL）return;

正确的书写方式：

if（NULL==pUserCR）

{

return;

}

●【规则28】在比较表达式中，如果有常量，尽量把常量放在前面。

[建议]

这样，万一不小心把“==”误敲成“=”，就会通不过翻译，不致引起难查的问题。

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

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

[建议]

示例：

本规则的特例见2－7的说明部分。

不正确的书写方式：

for（...）{

...//programcode

}

if（...）

{

...//programcode

}

voidexample_fun（void）

{

...//programcode

}

正确的书写方式：

for（...）

{

...//programcode

}

if（...）

{

...//programcode

}

voidexample_fun（void）

{

...//programcode

}

switch（var）

{

caseOPTION1:

break;

caseOPTION2:

if（CONDITION

{

/*code*/

}

break;

default:

break;

}

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

[必须]

说明：

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

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

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

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

示例：

【规则210-1】逗号、分号只在后面加空格。

inta,b,c;

【规则210-2】比较操作符,赋值操作符"="、"+="，算术操作符"+"、"%"，逻辑操作符"&&"、"&"，位域操作符"<<"、"^"等双目操作符的前后加空格。

if（currentTime>=MAX_TIME_VALUE）

a=b+c;

a*=2;

a=b^2;

【规则210-3】"!

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

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

flag=!

isEmpty;//非操作"!

"与内容之间

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

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

【规则210-4】"->"、"."前后不加空格。

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

【规则210-5】if、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显。

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

3

注释

●【规则31】一般情况下，源程序有效注释量必须在20％以上（建议20-30%）。

[必须]

说明：

注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。

●【规则32】C代码不得使用C++的注释语法“//”，必须使用/*….*/。

[建议]

注：

本文档的示例中，如有使用“//”，并非代码注释，而是文档的注释（有可能是文档中对代码注释的解释）。

●【规则33】说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：

版权说明、模块名、文件名、作者、内容介绍、修改日志等，头文件的注释中还应有函数功能简要说明。

[必须]

头文件模板示例：

/***********************************************************************

*

*（c）Copyright2001-2016,TRZN,AllRightsReserved.

*THISISUNPUBLISHEDPROPRIETARYSOURCECODEOFTRZN,INC.

*Thecopyrightnoticeabovedoesnotevidenceanyactualorintended

*publicationofsuchsourcecode.

*

*Subsystem:

XXX

*File:

XXX_ei.h

*Author:

Xxx

*Description:

TemplateforCheaderfiles.

*

*//其它在头文件可选择的包括的内容

*Others:

//其它内容的说明

*FunctionList:

//主要函数列表，每个函数一行，包含其返回值类型及参数类型。

功能说明应当放在函数头注释中

*1.....

*History:

//修改历史记录列表，每条修改记录应包括修改日期、修改

*//者及修改内容简述。

（参见底注）

*1.Date:

*Author:

*Modification:

*2....

*

*********************************************************************/

#ifndef_

#define_

//programcode

#endif/*_*/

【规则33-1】注：

使用git在commit代码时填写充分、准确的message。

[必须]

【规则33-2】为了防止头文件被重复引用，应当用#ifndef/#define/#endif结构产生预处理块。

[必须]

【规则33-3】用#include<>格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。

[必须]

【规则33-4】用#include“”格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。

[必须]

【规则33-5】头文件中只存放“声明”而不存放“定义”。

（建议将成员函数的定义与声明分开，不论该函数体有多么小。

）[必须]

●【规则34】源文件头部应进行注释，列出：

版权说明、版本号、作者、模块目的/功能、主要函数及其功能、修改日志等。

[必须]

源文件模板示例：

/******************************************************************

*（c）Copyright2001-2005,TRZN,AllRightsReserved.

*THISISUNPUBLISHEDPROPRIETARYSOURCECODEOFTRZN,INC.

*Thecopyrightnoticeabovedoesnotevidenceanyactualorintended

*publicationofsuchsourcecode.

*

*Subsystem:

XXX

*File:

XXX_config.c

*Author:

Xxxxx

*Description:

TemplateforCsourcefiles.

*

*//可选择的增加部分内容

*FunctionList:

//主要函数列表，每个函数一行，包含其返回值类型及参数类型。

功能说明应当放在函数头注释中

*1.....

*History:

//修改历史记录列表，每条修改记录应包括修改日期、修改

*//者及修改内容简述。

（参见底注）

*1.Date:

*Author:

*Modification:

*2....

*

***************************************************************/

/*说明：

Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。

History是修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。

*/

#include"xxxxxx.h"

/********************************************************************

*

*FunctionName:

XXX_Func1

*Input:

Param1-meaning;

*Param2-meaning;

*Output:

Ifthere'snoparametersforoutput,thisfieldcanbe

*"None"oromitted.

*Returns:

OK,ERROR

*Description:

ThisisanexternalfunctionofXXX.

*

**********************************************************************/

STATUSXXX_Func1（UINT8Param1,UINT32Param2）

{

}

【规则34-1】注：

使用git在commit代码时填写充分、准确的message。

[必须]

●【规则35】函数头部应进行注释，列出：

函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。

[必须]

函数注释模板示例：

/****************************************************************************

*

*FunctionName:

XXX_ExternalFunc1

*Input:

Param1-meaning;

*Param2-meaning;

*Output:

Ifthere'snoparametersforoutput,thisfieldcanbe

*"None"oromitted.

*Returns:

OK,ERROR

*Description:

Performsxxxfunctions.

*Note:

Anyspecialnote.Thiscanbeomitted.

*

*//其它可选择的函数头说明

*Calls:

//被本函数调用的函数清单

*CalledBy:

//调用本函数的函数清单

*TableAccessed:

//被访问的表（此项仅对于牵扯到数据库操作的程序）

*TableUpdated:

//被修改的表（此项仅对于牵扯到数据库操作的程序）

*Others:

//其它说明

*

***************************************************************************/

STATUSXXX_ExternalFunc1（UINT8Param1,UINT32Param2）;

【规则35-1】外部函数必须有函数头注释。

[必须]

【规则35-2】内部函数强烈建议使用函数头注释。

[建议]

●【规则36】边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。

不再有用的注释要删除。

注释的格式尽量统一。

[必须]

示例：

单行注释

/*Createaoneshottimer,fromnow.*/

多行注释

/*OneormoretablesoflteDevDescrstructuresmustalsobedefinedforeach

boardtypeintothedynamically-loadedboard-specificconfigurationfile.

Thedevicedescriptorprovidesfunctionpointersthatgivestandard

lineterminationequipmentAPIaccesstoaspecifichardwaredriver.*/

●【规则37】注释的内容要清楚、明了，含义准确，防止注释二义性。

[建议]

说明：

错误的注释不但无益反而有害。

●【规则38】避免在注释中使用缩写，特别是非常用缩写。

[建议]

说明：

在使用缩写时或之前，应对缩写进行必要的说明。

●【规则39】注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面；如放于上方则需与其上面的代码用空行隔开。

[必须]

示例：

如下例子不符合规范。

例1（错）：

/*getreplicatesubsystemindexandnetindicator*/

rprRepssnInd=rprSsnData[index].nRepssnIndex;

rprRepssnNi=rprSsnData[index].ni;

例2（错）：

rprRepssnInd=rprSsnData[index].nRepssnIndex;

rprRepssnNi=rprSsnData[index].ni;

/*getreplicatesubsystemindexandnetindicator*/

应如下书写

/*getreplicatesubsystemindexandnetindicator*/

rprRepssnInd=rprSsnData[index].nRepssnIndex;

rprRepssnNi=rprSsnData[index].ni;

●【规则310】对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。

变量、常量、宏的注释应放在其上方相邻位置或右方。

[必须]

示例：

示例1：

/*activestatistictasknumber*/

#defineSYS_MAX_ACT_TASK_NUMBER1000

示例2：

#defineSYS_MAX_ACT_TASK_NUMBER1000/*activestatistictasknumber*/

●【规则311】数据结构声明（包括数组、结构、类、枚举等），如果其命名不是充分自注释的，必须加以注释。

对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释放在此域的右方。

[必须]

示例：

可按如下形式说明枚举/数据/联合结构。

/*sccpinterfacewithsccpuserprimitivemessagename*/

typedefenumSCP_USER_PRIMITIVE_t

{

SCP_UNITDATA_IND,/*sccpnotifysccpuserunitdatacome*/

SCP_NOTICE_IND,/*SccpnotifyusertheNo.7networkcannot

transmissionthismessage*/

SCP_UNITDATA_REQ,/*sccpuser'sunitdatatransmissionrequest*/

}SCP_USER_PRIMITIVE_T;

●【规则312】全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。

[必须]

示例：

/*TheErrorCodewhenSCCPtranslate

GlobalTitlefailure,asfollows

0－SUCCESS

1－GTTableerror

2－GTerror

Others－notused

OnlyfunctionSCCP_Translate（）in

thismodualcanmodifyit,andother

modulecanvisititthroughcall

thefunctionSCCP_GetGTTransErrorCode（）*/

UINT8gGTTranErrorCode;

●【规则313】代码中的特殊处理，或者软件改变方