嵌入式软件编程规范

. 精选文档 TRZN 嵌入式软件编程规范嵌入式软件编程规范 . 精选文档 文档修改文档修改历历史：史： 版本号版本号日期日期修改者修改者及常用及常用邮邮箱箱修改日志修改日志 0.12016-10-28 杨科 ykee126 根据查阅的相关资料整理，此版本为第一次提交。 . 精选文档 1文档概述文档概述.4 1.1关于本文档.4 1.2参考文献.4 2排版排版.5 3注注释释.10 4标识标识符命名符命名.19 5可可读读性性.25 6变变量、量、结结构构 .26 7宏宏.31 8函数、函数、过过程程 .33 9可可测测性性.41 10代代码码版本管理版本管理.44 10.1代码质量定义.44 10.2GIT分支定义 .44 10.3GIT代码引入规定 .44 10.4GIT代码 COMMIT顺序.45 10.5COMMIT文件过程中的其他注意事项.45 11附附录录 A 推荐推荐编辑编辑器的默器的默认认配置修改配置修改.46 11.1KEIL UVISION5 默认配置修改.46 . 精选文档 1文档概述文档概述 1.1关于本文档关于本文档 本文档规范了芜湖天人智能有限公司嵌入式软件部软件代码的书写规范和原则。 本文档仅供公司内部员工使用。 公司机密，严禁外传。 本文档中各规则的格式如下： 【规则 编号】 规则内容 标记 其中其中标记标记的含的含义义如下：如下： （必（必须须） ） ： ： 表示表示该该条条规则规则是必是必须须遵守的。遵守的。 （建（建议议） ） ： ： 表示表示该该条条规则规则是建是建议议遵守的。遵守的。 （可（可选选）或没有）或没有标记标记 ： ： 表示表示该该条条规则规则是可是可选择选择遵守的。遵守的。 本文档的示例中，如有使用“/”，并非代码注释，而是文档的注释(有可能是文档中对代码注释的解释)。 1.2参考文献参考文献 1高质量 C+编程 2Effective C+ 3More Effective C+ 4C+ Primer 5Thinking in C+ . 精选文档 2排版排版 【 【规则规则 2-1】 】程序程序块块要采用要采用缩进风缩进风格格编编写，写，缩进缩进的空格数的空格数为为4个个,对齐对齐使用空格使用空格键键，不得使用，不得使用TAB键键。 。必必须须 嵌入式软件开发的代码编辑器，推荐使用 Keil uVision5，编辑器参数设置见附录 A。 【 【规则规则 2-2】 】相相对对独立的程序独立的程序块块之之间间、 、变变量量说说明之后必明之后必须须加空行。加空行。必必须须 示例： 不正确的不正确的书书写方式：写方式： if (!rpr_valid_ni(ni) . / program code gRprRepssnInd = gRprSsnDataidx.repssn_index; gRprRepssnNi = gRprSsnDataidx.ni; 正确的正确的书书写方式写方式: if (!rpr_valid_ni(ni) . / program code /空行 gRprRepssnInd = gRprSsnDataidx.repssn_index; gRprRepssnNi = gRprSsnDataidx.ni; 【 【规则规则 2-3】 】较长较长的的语语句（句（80字符）要分成多行字符）要分成多行书书写，写，长长表达式要在低表达式要在低优优先先级级操作符操作符处处划分新行，操作符放划分新行，操作符放 在新行之首，划分出的新行要在新行之首，划分出的新行要进进行适当的行适当的缩进缩进，使排版整，使排版整齐齐， ，语语句可句可读读。 。必必须须 示例： gRprPermCountMsg.head.len = RPR_NO7_TO_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) 【 【规则规则 2-4】 】循循环环、判断等、判断等语语句中若有句中若有较长较长的表达式或的表达式或语语句，句，则则要要进进行适当的分行，行适当的分行，长长表达式要在低表达式要在低优优先先级级 操作符操作符处处划分新行，操作符放在行尾。划分新行，操作符放在行尾。必必须须 示例： . 精选文档 if (taskno gSysMaxActTaskNumber) (i rprBufferKeywordwordIndex.nWordLength) i+, j+) . / program code /空行 for (i = 0, j = 0; (i 、.前后不加空格。 p-id = pid; / -指针前后不加空格 【 【规则规则 2-10-5】 】if、for、while、switch 等与后面的括号间应加空格，使 if 等关键字更为突出、明显。 if (a = b) * Param2 - meaning; * Output: If theres no parameters for output, this field can be * None or omitted. * Returns: OK,ERROR * Description: This is an external function of XXX. * */ STATUS XXX_Func1(UINT8 Param1, UINT32 Param2) 【 【规则规则 3-4-1】 】注：使用注：使用 git 在在 commit 代代码时码时填写充分、准确的填写充分、准确的 message。 。必必须须 【 【规则规则 3-5】 】函数函数头头部部应进应进行注行注释释，列出：函数的目的，列出：函数的目的/功能、功能、输输入参数、入参数、输输出参数、返回出参数、返回值值、 、调调用关系（函数、用关系（函数、 表）等。表）等。必必须须 函数注释模板示例： /* * * Function Name: XXX_ExternalFunc1 * Input: Param1 - meaning; * Param2 - meaning; * 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: / 被访问的表（此项仅对于牵扯到数据库操作的程序） * Table Updated: / 被修改的表（此项仅对于牵扯到数据库操作的程序） * Others: / 其它说明 * */ STATUS XXX_ExternalFunc1(UINT8 Param1, UINT32 Param2); . 精选文档 【 【规则规则 3-5-1】 】外部函数必外部函数必须须有函数有函数头头注注释释。 。必必须须 【 【规则规则 3-5-2】 】内部函数内部函数强强烈建烈建议议使用函数使用函数头头注注释释。 。建建议议 【 【规则规则 3-6】 】边边写代写代码边码边注注释释，修改代，修改代码码同同时时修改相修改相应应的注的注释释，以保，以保证证注注释释与代与代码码的一致性。不再有用的注的一致性。不再有用的注 释释要要删删除。注除。注释释的格式尽量的格式尽量统统一。一。 必必须须 示例： 单行注释 /* Create a one shot timer, from now. */ 多行注释 /* One or more tables 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. */ 【 【规则规则 3-7】 】注注释释的内容要清楚、明了，含的内容要清楚、明了，含义义准确，防止注准确，防止注释释二二义义性。性。建建议议 说明：错误的注释不但无益反而有害。 【 【规则规则 3-8】 】避免在注避免在注释释中使用中使用缩缩写，特写，特别别是非常用是非常用缩缩写写。 。建建议议 说明：在使用缩写时或之前，应对缩写进行必要的说明。 【 【规则规则 3-9】 】注注释应释应与其描述的代与其描述的代码码相近，相近，对对代代码码的注的注释应释应放在其上方或右方（放在其上方或右方（对单对单条条语语句的注句的注释释）相）相邻邻位置，位置， 不可放在下面；不可放在下面；如放于上方如放于上方则则需与其上面的代需与其上面的代码码用空行隔开用空行隔开。 。必必须须 示例：如下例子不符合规范。 例 1(错)： /* get replicate sub system index and net indicator */ rprRepssnInd = rprSsnDataindex.nRepssnIndex; rprRepssnNi = rprSsnDataindex.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; 【 【规则规则 3-10】 】对对于所有有物理含于所有有物理含义义的的变变量、常量，如果其命名不是充分自注量、常量，如果其命名不是充分自注释释的，在声明的，在声明时时都必都必须须加以注加以注释释， ， . 精选文档 说说明其物理含明其物理含义义。 。变变量、常量、宏的注量、常量、宏的注释应释应放在其上方相放在其上方相邻邻位置或右方。位置或右方。必必须须 示例： 示例 1： /* active statistic task number */ #define SYS_MAX_ACT_TASK_NUMBER 1000 示例 2： #define SYS_MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */ 【 【规则规则 3-11】 】数据数据结结构声明构声明(包括数包括数组组、 、结结构、构、类类、枚、枚举举等等)，如果其命名不是充分自注，如果其命名不是充分自注释释的，必的，必须须加以注加以注释释。 。 对对数据数据结结构的注构的注释应释应放在其上方相放在其上方相邻邻位置，不可放在下面；位置，不可放在下面；对结对结构中的每个域的注构中的每个域的注释释放在此域的右方。放在此域的右方。必必 须须 示例：可按如下形式说明枚举/数据/联合结构。 /* sccp interface with sccp user primitive message name */ typedef enum SCP_USER_PRIMITIVE_t SCP_UNITDATA_IND, /* sccp notify sccp user unit data come */ SCP_NOTICE_IND, /* Sccp notify user the No.7 network can not transmission this message */ SCP_UNITDATA_REQ, /* sccp users unit data transmission request*/ SCP_USER_PRIMITIVE_T; 【 【规则规则 3-12】 】全局全局变变量要有量要有较详细较详细的注的注释释，包括，包括对对其功能、取其功能、取值值范范围围、哪些函数或、哪些函数或过过程存取它以及存取程存取它以及存取时时注注 意事意事项项等的等的说说明。明。必必须须 示例： /* The ErrorCode when SCCP translate Global Title failure, as follows 0 SUCCESS 1 GT Table error 2 GT error Others not used Only function SCCP_Translate() in this modual can modify it, and other module can visit it through call the function SCCP_GetGTTransErrorCode() */ UINT8 gGTTranErrorCode; 【 【规则规则 3-13】 】代代码码中的特殊中的特殊处处理，或者理，或者软软件改件改变变方案，必方案，必须须加注加注释释，注明，注明为为何要何要这样这样做。做。必必须须 . 精选文档 说明：只有加了注释，以后的维护者才有可能明白前因后果。 【 【规则规则 3-14】 】注注释释与所描述内容与所描述内容进进行同行同样样的的缩缩排。排。必必须须 说明：可使程序排版整齐，并方便注释的阅读与理解。 示例：如下例子，不正确的布局，排版不整齐，阅读稍感不方便。 不正确的不正确的布局布局： ： void example_fun( void ) /* code one comments */ CodeBlock One /* code two comments */ CodeBlock Two 正确的布局：正确的布局： void example_fun( void ) /* code one comments */ CodeBlock One /* code two comments */ CodeBlock Two 【 【规则规则 3-15】 】将注将注释释与其上面的代与其上面的代码码用空行隔开。用空行隔开。必必须须 示例： 如下例子，如下例子，显显得代得代码过码过于于紧紧凑：凑： /* code one comments */ program code one /* code two comments */ program code two 应应如下如下书书写写： ： /* code one comments */ program code one /* code two comments */ program code two 【 【规则规则 3-16】 】对变对变量的定量的定义义和分支和分支语语句（条件分支、循句（条件分支、循环语环语句等）必句等）必须编须编写注写注释释。 。建建议议 说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序。 【 【规则规则 3-17】 】对对于于switch语语句下的句下的case语语句，如果因句，如果因为为特殊情况需要特殊情况需要处处理完一个理完一个case后后进进入下一个入下一个case处处理，理， 必必须须在在该该case语语句句处处理完、下一个理完、下一个case语语句前句前加上明确的注加上明确的注释释。 。必必须须 说明：这样比较清楚程序编写者的意图，有效防止无故遗漏 break 语句。 示例（注意斜体加粗部分）： 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; . 【 【规则规则 3-18】 】避免在一行代避免在一行代码码或表达式的中或表达式的中间间插入注插入注释释。 。必必须须 说明：除非必要（如 PC-LINT 的行禁止检查标记），不应在代码或表达中间插入注释，否则容易使代码可理解性 变差。 【 【规则规则 3-19】 】通通过对过对函数或函数或过过程、程、变变量、量、结结构等正确的命名以及合理地构等正确的命名以及合理地组织组织代代码码的的结结构，使代构，使代码码成成为为自注自注释释 的。的。建建议议 说明：清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释。 【 【规则规则 3-20】 】代代码码的功能、意的功能、意图层图层次上次上进进行注行注释释，提供有用、，提供有用、额额外的信息。外的信息。建建议议 说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必 要的重复注释信息。 示例： 如下注释意义不大。 /* if receive_flag is TRUE */ if (receive_flag) 而如下的注释则给出了额外有用的信息。 /* if mtp receive a message from links */ if (receive_flag) 【 【规则规则 3-21】 】在程序在程序块块的的结结束行右方加注束行右方加注释标记释标记，以表明某程序，以表明某程序块块的的结结束。束。可可选选 说明：当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。在 Source Insight 软件中可 以自动显示这类信息。 示例：参见如下例子。 . 精选文档 if (flag) / program code while (index MAX_INDEX) / program code /* end of while (index MAX_INDEX) */ / 指明该条 while 语句结束 /* end of if (flag)*/ / 指明是哪条 if 语句结束 【 【规则规则 3-22】 】注注释应释应考考虑虑程序易程序易读读及外及外观观排版的因素，嵌入式排版的因素，嵌入式软软件的注件的注释释必必须须全部使用英文。全部使用英文。 建建议议 . 精选文档 4 4标识标识符命名符命名 【 【规则规则 4-1】 】标识标识符的命名要清晰、明了，有明确含符的命名要清晰、明了，有明确含义义，同，同时时使用完整的使用完整的单词单词或大家基本可以理解的或大家基本可以理解的缩缩写，避写，避 免使人免使人产产生生误误解。解。建建议议 说明：较短的单词可通过去掉“元音”形成缩写；较长的单词可取单词的头几个字母形成缩写；一些单词有大家 公认的缩写。 示例：如下单词的缩写能够被大家基本认可。 temp 可缩写为 tmp; flag 可缩写为 flg; statistic 可缩写为 stat; increment 可缩写为 inc; decrease 可缩写为 dec; message 可缩写为 msg; reserve 可缩写为 resv; receive 可缩写为 rec; 【 【规则规则 4-2】 】命名中若使用特殊命名中若使用特殊约约定或定或缩缩写，写，则则要有注要有注释说释说明。明。必必须须 说明：应该在源文件的开始之处，对文件中所使用的缩写或约定，特别是特殊的缩写，进行必要的注释说明。 【 【规则规则 4-3】 】自己特有的命名自己特有的命名风风格，要自始至格，要自始至终终保持一致，不可来回保持一致，不可来回变变化。化。建建议议 说明：个人的命名风格，在符合所在项目组或产品组的命名规则的前提下，才可使用。（即命名规则中没有规定 到的地方才可有个人命名风格）。 【 【规则规则 4-4】 】常量的定常量的定义义全部采用大写全部采用大写单词单词， ，单词单词中中间间以下划以下划线线分开，并且各模分开，并且各模块块中的常量第一个中的常量第一个单词单词必必须须 为为模模块头块头，定，定义义的常数必的常数必须须加括号。加括号。必必须须 示例： #define RPR_STATUS_CALLBACK （1） #define RPR_RET_ERR_CODE_NULL （2） 【 【规则规则 4-5】 】结结构的命名必构的命名必须须全部全部为为大写字母，第大写字母，第1个个单词为单词为模模块块名，最后一个名，最后一个单词为单词为 _T， ，单词单词之之间间以下以下 划划线线分开。分开。必必须须 说明： 示例： typedef struct RVP_MSG_HDR_t UINT32 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_t RVP_MSG_HDR_T msgHdr; UINT8 ucSvcNum; UINT8 ucSvcCode; UINT16 usSvcLen; UINT32 unSvcData1; UINT32 unSvcData2; UINT32 unSvcData3; RVP_RESV_MSG_T; 【 【规则规则 4-6】 】枚枚举类举类型的命名必型的命名必须须全部全部为为大写字母，第大写字母，第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; 【 【规则规则 4-7】 】对对于于变变量命名，禁止取量命名，禁止取单单个字符（如个字符（如i、 、j、 、k.），建），建议议除了要有具体含除了要有具体含义义外，外，还还能表明其能表明其变变量量类类型、型、 数据数据类类型等，但型等，但i、 、j、 、k作局部循作局部循环变环变量是允量是允许许的。的。必必须须 【 【规则规则 4-8】 】变变量名中的大小写与分隔：使用量名中的大小写与分隔：使用单词单词首字母大写作首字母大写作为变为变量中各量中各单词单词的的间间隔，隔，变变量的打量的打头头字母、字母、 打打头单词头单词必必须须小写，禁止使用下划小写，禁止使用下划线线(“_”)做做变变量中的分割符。量中的分割符。必必须须 例如： UINT32 dccResetAddr; STATUS rprInstStatus; 【 【规则规则 4-9】 】全局全局变变量的量的头头部必部必须须有有“g+subsystem”的的标记标记，用于区分全局，用于区分全局变变量的模量的模块块范范围围，同，同时时防止重名。防止重名。 相同模相同模块块内的全局内的全局变变量必量必须须尽量放在同一个文件中。尽量放在同一个文件中。必必须须 例如： UINT8 gFmaVariableName; char gsRprModuleNameRPR_MAX_STRING_LEN; 【 【规则规则 4-10-1】 】模模块块的全局的全局变变量必量必须组织须组织在同一个在同一个结结构体中构体中进进行管理。行管理。必必须须 . 精选文档 例如 STP 模块中的全局变量定义如下： typedef struct MIBpbRstpBridgeTable_t stp_gBridgeCfg; MIBpbRstpPortTable_t stp_gPortCfgHII_MAX_PORT_NUM; stp_BridgeData_s stp_gBridgeInfo; stp_PortData_s stp_gPortInfoHII_MAX_PORT_NUM; stp_StateMachine_s stp_gPortSMHII_MAX_PORT_NUM; stp_BPDU_s stp_gRcvdBPDUHII_MAX_PORT_NUM; int stp_gTimerOneSecond; STP_S_STPInfo_T; 在 stp_config.c 中采用该结构定义的变量如下： STP_S_STPInfo_T *stp_gGvarHII_MAX_INSTANCE_NUM; 【 【规则规则 4-11】 】 变变量的前量的前缀缀表示方法表示方法必必须须 类类型型描述描述前前缀缀举举例例 *指针pUINT8 *pucIndex; 定长数组a (optional)UINT8 aMyVarMAX_LEN; BOOL布尔值bBOOL bMonitored; char字符串schar sTtiTx64; UINT88-bit 无符号整数uc (optional)UINT8 ucIndex; or UINT8 index; UINT1616-bit 无符号整数us (optional)UINT16 usPort; or UINT16 port; UINT3232-bit 无符号整数ul (optional)UINT32 ulErrorCode; char可显示字符c (optional)char cHexHigher4Bits, cHexLower4Bits; int依赖于操作系统的不定长整数 (不建议使用) n (optnional)int nIndex; or int j; UINT依赖于操作系统的不定长无符 号整数(不建议使用) u (optional) Enum枚举e (optional) (other)其他复杂类型(如结构)按惯例或自行定义 (注意全局一致) MSG_Q_ID msgQPmon; Table 1 变变量的前量的前缀缀 说明：变量的前缀可以由各中前缀组合表示.（变量的命名来自参考文献1） 例如： BOOL gbPslEnabled UINT32 *gpulHandle; 【 【规则规则 4-12】 】通用通用类类型定型定义义的使用：尽可能使用的使用：尽可能使用CTD(Common Type Definitions)中定中定义义的数的数值类值类型，尽量少型，尽量少 定定义义自己的数据自己的数据类类型型(在不影响程序可在不影响程序可读读性的前提下性的前提下)。 。必必须须 CTD 包括以下定义： 通用的常量和类型定义，如 UINT8，UINT16，UINT32 与 SDH 有关的通用常量和类型定义 . 精选文档 通用错误返回码 PB_ERROR_CODE_T 【 【规则规则 4-13】 】除非必要，不要用数字或除非必要，不要用数字或较较奇怪的字符来定奇怪的字符来定义标识义标识符。符。 示例：如下命名，使人产生疑惑。 #define _RPR_0_TEST_ #define _RPR_1_TEST_ void set_sls00( UINT8 sls ); 应改为有意义的单词命名: #define _RPR_EXAMPLE_UNIT_TEST_ #define _RPR_EXAMPLE_ASSERT_TEST_ void RPR_setUdtMsgSls(UINT8 ucSls ); 【 【规则规则 4-14】 】用正确的反用正确的反义词组义词组命名具有互斥意命名具有互斥意义义的一的一组变组变量或相反量或相反动动作的一作的一组组函数等。不得把意函数等。不得把意义义相反相反 的的单词单词合并在一个合并在一个变变量名或函数名中，以免意量名或函数名中，以免意义义不清。不清。建建议议 说明：下面是一些在软件中常用的反义词组。 add / remove begin / end create / destroy insert / delete first / last get / release increment / decrement put / get add / delete lock / unlock open / close min / max old / new start / stop next / previous source / target show / hide send / receive source / destination cut / paste up / down 示例： int minSum; int maxSum; int addUser( UINT8 *u