嵌入式软件编程规范.doc

《嵌入式软件编程规范.doc》由会员分享，可在线阅读，更多相关《嵌入式软件编程规范.doc（48页珍藏版）》请在得力文库 - 分享文档赚钱的网站上搜索。

1、TRZN工程： Embedded software development领域： SW Engineering文件名称： 嵌入式软件编程规X文件号: SW-00-00-0001版本号: 0.1日期: 2021-10-28所属部门: 电控质量管理部. .TRZN嵌入式软件编程规X文档修改历史：0.12021-10-28杨科ykee126126.根据查阅的相关资料整理，此版本为第一次提交。1文档概述41.1关于本文档41.2参考文献42排版53注释104标识符命名195可读性256变量、构造267宏318函数、过程339可测性4110代码版本管理4410.1代码质量定义4410.2Git分支定义4

2、410.3Git代码引入规定4410.4Git代码mit顺序4510.5mit文件过程中的其他考前须知4511附录A 推荐编辑器的默认配置修改4611.1Keil uVision5默认配置修改461 文档概述1.1 关于本文档本文档规X了XX天人智能XX嵌入式软件部软件代码的书写规X和原那么。本文档仅供公司内部员工使用。公司XX，严禁外传。本文档中各规那么的格式如下：【规那么 编号】 规那么内容 标记其中标记的含义如下：必须：表示该条规那么是必须遵守的。建议： 表示该条规那么是建议遵守的。可选或没有标记：表示该条规那么是可选择遵守的。本文档的例如中，如有使用“/，并非代码注释，而是文档的注释(

3、有可能是文档中对代码注释的解释)。1.2 参考文献1高质量C+编程2Effective C+3More Effective C+4C+ Primer5Thinking in C+2 排版l 【规那么 21】程序块要采用缩进风格编写，缩进的空格数为4个,对齐使用空格键，不得使用TAB键。必须嵌入式软件开发的代码编辑器，推荐使用Keil uVision5，编辑器参数设置见附录A。l 【规那么 22】相对独立的程序块之间、变量说明之后必须加空行。必须例如：不正确的书写方式：if (!rpr_valid_ni(ni) . / program codegRprRepssnInd= gRprSsnData

4、idx.repssn_index;gRprRepssnNi = gRprSsnDataidx.ni;正确的书写方式:if (!rpr_valid_ni(ni) . / program code/空行gRprRepssnInd = gRprSsnDataidx.repssn_index;gRprRepssnNi = gRprSsnDataidx.ni;l 【规那么 23】较长的语句80字符要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进展适当的缩进，使排版整齐，语句可读。必须例如：gRprPermCountMsg.head.len = RPR_NO7_T

5、O_STAT_PERM_COUNT_LEN +RPR_STAT_SIZE_PER_FRAM * sizeof( UINT32 );gSysAcbTaskTableframe_id * RPR_STAT_TASK_CHECK_NUMBER + index.nOccupied =rprStatPoiindex.nOccupied;gSysAcbTaskTabletaskno.nDurationTrueOrFalse =SYS_getSccpStatisticState( statItem );gRprReportOrNotFlag = (SYS_MAX_ACT_TASK_NUMBER taskno

6、) & (SYS_n7statStatItemValid (statItem) & (0 != gSYSActTaskTabletaskno.resultData);l 【规那么 24】循环、判断等语句中假设有较长的表达式或语句，那么要进展适当的分行，长表达式要在低优先级操作符处划分新行，操作符放在行尾。必须例如：if (taskno gSysMaxActTaskNumber) & (SYS_n7statStatItemValid (statItem) . / program code/空行for (i = 0, j = 0; (i rprBufferKeywordwordIndex.nWor

7、dLength) &(j rprNewKeyword.nWordLength); i+, j+) . / program code/空行for (i = 0, j = 0; (i rprFirstWordLength) & (j rprSecondWordLength); i+, j+) . / program code l 【规那么 25】假设函数的参数较长，那么要进展适当的分行。必须例如：rpr_n7statStrpare(UINT8 *) & statObject,(UINT8 *) & (gSysActTaskTabletaskno.statObject),sizeof (SYS_ST

8、AT_OBJECT);rpr_n7statFlashActDuration( statItem, frameId *SYS_STAT_TASK_CHECK_NUMBER+ index, statObject );l 【规那么 26】不允许把多个短语句写在一行中，即一行只写一条语句。必须例如：不正确的书写方式：rect.nLength = 0; rect.nWidth = 0;正确的书写方式：rect.nLength = 0;rect.nWidth = 0;l 【规那么 27】if、for、do、while、case、switch、default等语句自占一行，且if、for、do、while等

9、语句的执行语句局部无论多少都要加括号。必须例如：不正确的书写方式：if (pUserCR = NULL) return;正确的书写方式：if (NULL = pUserCR) return;l 【规那么 28】在比拟表达式中，如果有常量，尽量把常量放在前面。建议这样，万一不小心把“=误敲成“=，就会通不过翻译，不致引起难查的问题。l 【规那么 29】程序块的分界符如C/C+语言的大括号和应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开场、类的定义、构造的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。建议例如：本

10、规那么的特例见27的说明局部。不正确的书写方式：for (.) . / program codeif (.) . / program code void example_fun( void ) . / program code 正确的书写方式：for (.) . / program codeif (.) . / program codevoid example_fun( void ) . / program codeswitch(var) case OPTION1: break; case OPTION2: if (CONDITION ，后不应加空格。必须说明：采用这种松散方式编写代码的目的是

11、使代码更加清晰。由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰那么括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格，因为在C/C+语言中括号已经是最清晰的标志了。在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。例如：Error! Reference source not found.-1】逗号、分号只在后面加空格。int a, b, c; Error! Reference source not found.-2】比拟操作符, 赋值操作符=、 +=，算术操

12、作符+、%，逻辑操作符&、&，位域操作符= MAX_TIME_VALUE) a = b + c;a *= 2;a = b 2;Error! Reference source not found.-3】!、+、-、&地址运算符等单目操作符前后不加空格。*p = a; / 内容操作*与内容之间flag = !isEmpty; / 非操作!与内容之间p = &mem; / 地址操作& 与内容之间i+; / +,-与内容之间Error! Reference source not found.-4】-、.前后不加空格。p-id = pid; / -指针前后不加空格Error! Reference sou

13、rce not found.-5】if、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显。if(a = b) & (c d)3 注释l 【规那么 31】一般情况下，源程序有效注释量必须在20以上(建议20-30%)。必须说明：注释的原那么是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。l 【规那么 32】C代码不得使用C+的注释语法“/，必须使用/*.*/。建议注：本文档的例如中，如有使用“/，并非代码注释，而是文档的注释(有可能是文档中对代码注释的解释)。l 【规那么 33】说明性文件如头文件.h文件、

14、.inc文件、.def文件、编译说明文件.cfg等头部应进展注释，注释必须列出：说明、模块名、文件名、作者、内容介绍、修改日志等，头文件的注释中还应有函数功能简要说明。必须头文件模板例如：/* * * (c) Copyright 2001-2021, TRZN, All Rights Reserved. * THIS IS UNPUBLISHED PROPRIETARY SOURCE CODE OF TRZN, INC. * The copyright notice above does not evidence any actual or intended * publication of

15、such source code. * * Subsystem: XXX * File: XXX_ei.h * Author: Xxx * Description: TemplateforCheaderfiles. * /其它在头文件可选择的包括的内容 * Others: / 其它内容的说明*Function List: / 主要函数列表，每个函数一行，包含其返回值类型及参数类型。功能说明应当放在函数头注释中* 1. .*History: / 修改历史记录列表，每条修改记录应包括修改日期、修改*/ 者及修改内容简述。(参见底注)*1. Date:* Author:*Modification:*

16、2. .* */#ifndef _FILENAME_H#define _FILENAME_H/program code#endif /* _FILENAME_H */【规那么 33-1】注：使用git在mit代码时填写充分、准确的message。必须【规那么 33-2】为了防止头文件被重复引用，应当用#ifndef/#define/#endif构造产生预处理块。必须【规那么 33-3】用 #include 格式来引用标准库的头文件编译器将从标准库目录开场搜索。必须【规那么 33-4】用 #include “filename.h 格式来引用非标准库的头文件编译器将从用户的工作目录开场搜索。必须【

17、规那么 33-5】头文件中只存放“声明而不存放“定义。(建议将成员函数的定义与声明分开，不管该函数体有多么小。)必须l 【规那么 34】源文件头部应进展注释，列出：说明、版本号、作者、模块目的/功能、主要函数及其功能、修改日志等。必须源文件模板例如：/* * (c) Copyright 2001-2005, TRZN, All Rights Reserved. * THIS IS UNPUBLISHED PROPRIETARY SOURCE CODE OF TRZN, INC. * The copyright notice above does not evidence any actual

18、or intended * publication of such source code. * * Subsystem: XXX * File: XXX_config.c * Author: Xxxxx * Description: TemplateforCsourcefiles.* /可选择的增加局部内容 *Function List: /主要函数列表，每个函数一行，包含其返回值类型及参数类型。功能说明应当放在函数头注释中* 1. .*History: / 修改历史记录列表，每条修改记录应包括修改日期、修改*/ 者及修改内容简述。(参见底注)*1. Date:* Author:*Modif

19、ication:*2. .* */*说明：Description一项描述本文件的内容、功能、内部各局部之间的关系及本文件与其它文件关系等。History是修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。*/#include xxxxxx.h/* * * Function Name: XXX_Func1 * Input: Param1 - meaning; * Param2 - meaning; * Output: If theres no parameters for output, this field can be * None or omitted. * Return

20、s: OK,ERROR * Description: This is an external function of XXX. * */STATUS XXX_Func1(UINT8 Param1, UINT32 Param2)【规那么 34-1】注：使用git在mit代码时填写充分、准确的message。必须l 【规那么 35】函数头部应进展注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系函数、表等。必须函数注释模板例如：/* * Function Name: XXX_ExternalFunc1 * Input: Param1 - meaning; * Param2 - me

21、aning; * Output: If theres no parameters for output, this field can be * None or omitted. * Returns: OK,ERROR * Description: Performs xxx functions. * Note: Any special note. This can be omitted. * /其它可选择的函数头说明*Calls: / 被本函数调用的函数清单*Called By: / 调用本函数的函数清单*Table Accessed: / 被访问的表此项仅对于牵扯到数据库操作的程序*Tabl

22、e Updated: / 被修改的表此项仅对于牵扯到数据库操作的程序* Others: / 其它说明* */STATUS XXX_ExternalFunc1(UINT8 Param1, UINT32 Param2);【规那么 35-1】外部函数必须有函数头注释。必须【规那么 35-2】内部函数强烈建议使用函数头注释。建议l 【规那么 36】边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。注释的格式尽量统一。必须例如：单行注释/* Create a one shot timer, from now. */多行注释/* One or more table

23、s of lteDevDescr structures must also be defined for each board type into the dynamically-loaded board-specific configuration file. The device descriptor provides function pointers that give standard line termination equipment API access to a specific hardware driver. */l 【规那么 37】注释的内容要清楚、明了，含义准确，防止

24、注释二义性。建议说明：错误的注释不但无益反而有害。l 【规那么 38】防止在注释中使用缩写，特别是非常用缩写。建议说明：在使用缩写时或之前，应对缩写进展必要的说明。l 【规那么 39】注释应与其描述的代码相近，对代码的注释应放在其上方或右方对单条语句的注释相邻位置，不可放在下面；如放于上方那么需与其上面的代码用空行隔开。必须例如：如下例子不符合规X。例1(错)：/* get replicate sub system index and net indicator */rprRepssnInd = rprSsnDataindex.nRepssnIndex;rprRepssnNi = rprSsn

25、Dataindex.ni;例2(错)：rprRepssnInd = rprSsnDataindex.nRepssnIndex;rprRepssnNi = rprSsnDataindex.ni;/* get replicate sub system index and net indicator */应如下书写/* get replicate sub system index and net indicator */rprRepssnInd = rprSsnDataindex.nRepssnIndex;rprRepssnNi = rprSsnDataindex.ni;l 【规那么 310】对于所

26、有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。必须例如：例如1：/* active statistic task number */#define SYS_MAX_ACT_TASK_NUMBER 1000例如2：#define SYS_MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */l 【规那么 311】数据构造声明(包括数组、构造、类、枚举等)，如果其命名不是充分自注释的，必须加以注释。对数据构造的注释应放在其上方相邻位置，不可

27、放在下面；对构造中的每个域的注释放在此域的右方。必须例如：可按如下形式说明枚举/数据/联合构造。/* sccp interface with sccp user primitive message name */typedef enum SCP_USER_PRIMITIVE_tSCP_UNITDATA_IND, /* sccp notify sccp user unit data e */SCP_NOTICE_IND, /* Sccp notify user the No.7 network can nottransmission this message */SCP_UNITDATA_REQ

28、, /* sccp users unit data transmission request*/ SCP_USER_PRIMITIVE_T;l 【规那么 312】全局变量要有较详细的注释，包括对其功能、取值X围、哪些函数或过程存取它以及存取时考前须知等的说明。必须例如：/* The ErrorCode when SCCP translate Global Title failure, as follows 0 SUCCESS1 GT Table error2 GT error Others not usedOnly function SCCP_Translate() in this modua

29、l can modify it, and other module can visit it through call the function SCCP_GetGTTransErrorCode() */ UINT8 gGTTranErrorCode;l 【规那么 313】代码中的特殊处理，或者软件改变方案，必须加注释，注明为何要这样做。必须说明：只有加了注释，以后的维护者才有可能明白前因后果。l 【规那么 314】注释与所描述内容进展同样的缩排。必须说明：可使程序排版整齐，并方便注释的阅读与理解。例如：如下例子，不正确的布局，排版不整齐，阅读稍感不方便。不正确的布局：void example

30、_fun( void )/* code one ments */ CodeBlock One /* code two ments */ CodeBlock Two正确的布局：void example_fun( void ) /* code one ments */ CodeBlock One /* code two ments */ CodeBlock Twol 【规那么 315】将注释与其上面的代码用空行隔开。必须例如：如下例子，显得代码过于紧凑：/* code one ments */program code one/* code two ments */program code two应

31、如下书写：/* code one ments */program code one/* code two ments */program code twol 【规那么 316】对变量的定义和分支语句条件分支、循环语句等必须编写注释。建议说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序。l 【规那么 317】对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。必须说明：这样比拟清楚程序编写者的意图，有效防止无故遗漏break语句。例如注意

32、斜体加粗局部：case CMD_UP: ProcessUp(); break;case CMD_DOWN: ProcessDown(); break;case CMD_FWD: ProcessFwd(); ProcessCFW_B(); /* now jump into case CMD_A */case CMD_A: ProcessA(); break;case CMD_B: ProcessB(); break;default: break;.l 【规那么 318】防止在一行代码或表达式的中间插入注释。必须说明：除非必要如PC-LINT的行制止检查标记，不应在代码或表达中间插入注释，否那么容

33、易使代码可理解性变差。l 【规那么 319】通过对函数或过程、变量、构造等正确的命名以及合理地组织代码的构造，使代码成为自注释的。建议说明：清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释。l 【规那么 320】代码的功能、意图层次上进展注释，提供有用、额外的信息。建议说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。例如：如下注释意义不大。/* if receive_flag is TRUE */if (receive_flag)而如下的注释那么给出了额外有用的信息。/* if mtp receive a m

34、essage from links */if (receive_flag)l 【规那么 321】在程序块的完毕行右方加注释标记，以说明某程序块的完毕。可选说明：当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。在Source Insight软件中可以自动显示这类信息。例如：参见如下例子。if (flag) / program code while (index MAX_INDEX) / program code /* end of while (index MAX_INDEX) */ / 指明该条while语句完毕 /* end of if (flag)*/ / 指明是哪条i

35、f语句完毕l 【规那么 322】注释应考虑程序易读及外观排版的因素，嵌入式软件的注释必须全部使用英文。 建议4 标识符命名l 【规那么 41】标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家根本可以理解的缩写，防止使人产生误解。建议说明：较短的单词可通过去掉“元音形成缩写；较长的单词可取单词的头几个字母形成缩写；一些单词有大家公认的缩写。例如：如下单词的缩写能够被大家根本认可。temp 可缩写为 tmp;flag 可缩写为 flg;statistic 可缩写为 stat;increment 可缩写为 inc;decrease 可缩写为 dec;message 可缩写为 msg;r

36、eserve 可缩写为 resv;receive 可缩写为 rec;l 【规那么 42】命名中假设使用特殊约定或缩写，那么要有注释说明。必须说明：应该在源文件的开场之处，对文件中所使用的缩写或约定，特别是特殊的缩写，进展必要的注释说明。l 【规那么 43】自己特有的命名风格，要自始至终保持一致，不可来回变化。建议说明：个人的命名风格，在符合所在工程组或产品组的命名规那么的前提下，才可使用。即命名规那么中没有规定到的地方才可有个人命名风格。l 【规那么 44】常量的定义全部采用大写单词，单词中间以下划线分开，并且各模块中的常量第一个单词必须为模块头，定义的常数必须加括号。必须例如：#define

37、RPR_STATUS_CALLBACK 1#define RPR_RET_ERR_CODE_NULL 2l 【规那么 45】构造的命名必须全部为大写字母，第1个单词为模块名，最后一个单词为 _T，单词之间以下划线分开。必须说明：例如：typedef struct RVP_MSG_HDR_tUINT32 version:4; UINT32 resvd:16; UINT32 msgLen; /*the over all length of the message, excluding the header*/RVP_MSG_HDR_T;typedef struct RVP_RESV_MSG_tRV

38、P_MSG_HDR_TmsgHdr;UINT8 ucSvum;UINT8 ucSvcCode;UINT16 usSvcLen;UINT32 unSvcData1;UINT32 unSvcData2; UINT32 unSvcData3; RVP_RESV_MSG_T;l 【规那么 46】枚举类型的命名必须全部为大写字母，第1个单词为模块名，最后一个单词为 _T，单词之间以下划线分开。必须例如：typedef enum /* The Instance State Definition */PLB_INST_ERROR=-2,PLB_INST_DEINIT=-1,PLB_INST_DEACTIVE=0,PLB_INST_INIT,PLB_INST_STANDBY,PLB_INST_ACTIVE PLB_INST_STATE_T;l 【规那么 47】对于变量命名，制止取单个字符如i、j、k.，建议除了要有具体含义外，还能说明其变量类型、数据类型等，但i、j、k作局部循环变量是允许的。必须l 【规那么 48】变量名中的大小写与分隔：使用单词首字母大写作为变量中各单词的间隔，变量的打头字母、打头单词必须小写，制止使用下划线(“_)做变量中的分割符。必须例如：UINT32 dccResetAddr;STATU