2022年嵌入式软件编程规范.pdf

《2022年嵌入式软件编程规范.pdf》由会员分享，可在线阅读，更多相关《2022年嵌入式软件编程规范.pdf（34页珍藏版）》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。

1、嵌入式软件编程规范TRZN 嵌入式软件编程规范精品资料 - - - 欢迎下载 - - - - - - - - - - - 欢迎下载 名师归纳 - - - - - - - - - -第 1 页，共 34 页 - - - - - - - - - - 嵌入式软件编程规范文档修改历史: 0、1 2016-10-28 杨科ykee126126、com 根据查阅的相关资料整理,此版本为第一次提交。精品资料 - - - 欢迎下载 - - - - - - - - - - - 欢迎下载 名师归纳 - - - - - - - - - -第 2 页，共 34 页 - - - - - - - - - - 嵌入式软件编

2、程规范1文档概述 . 31、1关于本文档. 31、2参考文献 . 32排版 . 43注释 . 84标识符命名. 145可读性 . 196变量、结构. 197宏 . 238函数、过程. 249可测性 . 3010代码版本管理. 3210、1 代码质量定义 . 3210、2 GIT分支定义 . 3210、3 GIT代码引入规定 . 3210、4 GIT代码 COMMIT顺序 . 3310、5 COMMIT文件过程中的其她注意事项. 3311附录 A 推荐编辑器的默认配置修改 . 3411、1 KEIL UVISION5默认配置修改. 341 文档概述1.1 关于本文档本文档规范了芜湖天人智能有限公

3、司嵌入式软件部软件代码的书写规范与原则。本文档仅供公司内部员工使用。公司机密 ,严禁外传。本文档中各规则的格式如下: 【规则 编号】 规则内容 标记 其中 标记 的含义如下 : (必须 ) : 表示该条规则就是必须遵守的。(建议 ) : 表示该条规则就是建议遵守的。(可选 )或没有标记 : 表示该条规则就是可选择遵守的。本文档的示例中,如有使用“ /”,并非代码注释,而就是文档的注释(有可能就是文档中对代码注释的解释)。1.2 参考文献1 高质量 C+编程2Effective C+ 3More Effective C+ 4C+ Primer 5Thinking in C+ 精品资料 - - -

4、 欢迎下载 - - - - - - - - - - - 欢迎下载 名师归纳 - - - - - - - - - -第 3 页，共 34 页 - - - - - - - - - - 嵌入式软件编程规范2 排版【规则 2-1】程序块要采用缩进风格编写, 缩进的空格数为4个, 对齐使用空格键, 不得使用 TAB键。 必须嵌入式软件开发的代码编辑器,推荐使用Keil uVision5, 编辑器参数设置见附录A。【规则 2-2】相对独立的程序块之间、变量说明之后必须加空行。 必须 示例 : 不正确的书写方式:if (!rpr_valid_ni(ni) 、 / program code gRprRepss

5、nInd = gRprSsnDataidx、repssn_index; gRprRepssnNi = gRprSsnDataidx、ni; 正确的书写方式:if (!rpr_valid_ni(ni) 、 / program code /空行gRprRepssnInd = gRprSsnDataidx、repssn_index; gRprRepssnNi = gRprSsnDataidx、ni; 【规则 2-3】较长的语句 ( 80 字符 ) 要分成多行书写, 长表达式要在低优先级操作符处划分新行, 操作符放在新行之首, 划分出的新行要进行适当的缩进, 使排版整齐 ,语句可读。 必须 示例 :g

6、RprPermCountMsg、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 ); gRprReport

7、OrNotFlag = (SYS_MAX_ACT_TASK_NUMBER taskno) & (SYS_n7statStatItemValid (statItem) & (0 != gSYSActTaskTabletaskno、resultData); 【规则 2-4】循环、判断等语句中若有较长的表达式或语句, 则要进行适当的分行, 长表达式要在低优先级操作符处划分新行, 操作符放在行尾。 必须 示例 :精品资料 - - - 欢迎下载 - - - - - - - - - - - 欢迎下载 名师归纳 - - - - - - - - - -第 4 页，共 34 页 - - - - - - - -

8、- - 嵌入式软件编程规范if (taskno gSysMaxActTaskNumber) & (SYS_n7statStatItemValid (statItem) 、 / program code /空行for (i = 0, j = 0; (i rprBufferKeywordwordIndex、nWordLength) & (j rprNewKeyword、 nWordLength); i+, j+) 、 / program code /空行for (i = 0, j = 0; (i rprFirstWordLength) & (j rprSecondWordLength); i+,

9、j+) 、 / program code 【规则 2-5】若函数的参数较长,则要进行适当的分行。 必须 示例 :rpr_n7statStrCompare(UINT8 *) & statObject, (UINT8 *) & (gSysActTaskTabletaskno、statObject), sizeof (SYS_STAT_OBJECT); rpr_n7statFlashActDuration( statItem, frameId * SYS_STAT_TASK_CHECK_NUMBER + index, statObject ); 【规则 2-6】不允许把多个短语句写在一行中, 即一行

10、只写一条语句。 必须 示例 : 不正确的书写方式: rect、nLength = 0; rect、nWidth = 0; 正确的书写方式: rect、nLength = 0;rect、nWidth = 0; 【规则 2-7】 if、 for、 do 、 while、 case 、 switch、 default等语句自占一行, 且 if、for、do 、 while等语句的执行语句部分无论多少都要加括号 。 必须 精品资料 - - - 欢迎下载 - - - - - - - - - - - 欢迎下载 名师归纳 - - - - - - - - - -第 5 页，共 34 页 - - - - - -

11、 - - - - 嵌入式软件编程规范示例 : 不正确的书写方式: if (pUserCR = NULL) return; 正确的书写方式: if (NULL = pUserCR) return; 【规则 2-8】在比较表达式中, 如果有常量 ,尽量把常量放在前面。 建议 这样 ,万一不小心把“=”误敲成“ =”,就会通不过翻译,不致引起难查的问题。【规则 2-9】程序块的分界符(如C/C+ 语言的大括号 与 ) 应各独占一行并且位于同一列, 同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do 、 while、switch、case 语句中的程序都

12、要采用如上的缩进方式。 建议 示例 :本规则的特例见27 的说明部分。不正确的书写方式: for (、 ) 、 / program code if (、 ) 、 / program code void example_fun( void ) 、 / program code 正确的书写方式: for (、 ) 、 / program code if (、 ) 、 / program code void example_fun( void ) 、 / program code switch(var) case OPTION1: break; case OPTION2: if (CONDITION

13、 ), 后不应加空格。 必须 说明 :采用这种松散方式编写代码的目的就是使代码更加清晰。精品资料 - - - 欢迎下载 - - - - - - - - - - - 欢迎下载 名师归纳 - - - - - - - - - -第 6 页，共 34 页 - - - - - - - - - - 嵌入式软件编程规范由于留空格所产生的清晰性就是相对的,所以 ,在已经非常清晰的语句中没有必要再留空格,如果语句已足够清晰则括号内侧( 即左括号后面与右括号前面) 不需要加空格,多重括号间不必加空格,因为在 C/C+ 语言中括号已经就是最清晰的标志了。在长语句中 ,如果需要加的空格非常多,那么应该保持整体清晰,而

14、在局部不加空格。给操作符留空格时不要连续留两个以上空格。示例 :【规则 2-10-1 】逗号、分号只在后面加空格。int a, b, c; 【规则 2-10-2 】比较操作符 , 赋值操作符 = 、 +=,算术操作符 + 、% ,逻辑操作符 & 、& ,位域操作符 = MAX_TIME_VALUE) a = b + c; a *= 2; a = b 2; 【规则 2-10-3 】!、 、+、-、& (地址运算符 )等单目操作符前后不加空格。*p = a; / 内容操作 *与内容之间flag = !isEmpty; / 非操作 !与内容之间p = &mem; / 地址操作 & 与内容之间i+;

15、/ +,-与内容之间【规则 2-10-4 】-、 、 前后不加空格。p-id = pid; / -指针前后不加空格【规则 2-10-5 】if、for、while、switch等与后面的括号间应加空格,使 if等关键字更为突出、明显。if (a = b) & (c d) 精品资料 - - - 欢迎下载 - - - - - - - - - - - 欢迎下载 名师归纳 - - - - - - - - - -第 7 页，共 34 页 - - - - - - - - - - 嵌入式软件编程规范3 注释【规则 3-1】一般情况下 , 源程序有效注释量必须在20以上 ( 建议 20-30%)。 必须 说明

16、 :注释的原则就是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。【规则 3-2】C代码不得使用 C+的注释语法“ / ”, 必须使用 /* 、*/ 。 建议 注:本文档的示例中,如有使用“ /”,并非代码注释,而就是文档的注释(有可能就是文档中对代码注释的解释)。【规则 3-3】说明性文件( 如头文件、 h文件、 inc 文件、 def 文件、编译说明文件、cfg 等 ) 头部应进行注释, 注释必须列出: 版权说明、模块名、文件名、作者、内容介绍、修改日志等, 头文件的注释中还应有函数功能简要说明。 必须 头文件模板示例:/* * * (c)

17、 Copyright 2001-2016, 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 such source code、 * * Subsystem: XXX * File: XXX_ei、h * Author: Xxx * Description: Template for C header

18、 files、 * * /其它在头文件可选择的包括的内容* Others: / 其它内容的说明* Function List: / 主要函数列表,每个函数一行,包含其返回值类型及参数类型。功能说明应当放在函数头注释中* 1、 * History: / 修改历史记录列表,每条修改记录应包括修改日期、修改 * / 者及修改内容简述。( 参见底注 ) * 1、 Date: * Author: * Modification: * 2、* */ #ifndef _ #define _ /program code #endif /* _ */ 【规则 3-3-1】注 : 使用 git在 commit 代码

19、时填写充分、准确的message。 必须 【规则 3-3-2】为了防止头文件被重复引用, 应当用 #ifndef/#define/#endif结构产生预处理块。 必须 【规则 3-3-3】用 #include 格式来引用标准库的头文件( 编译器将从标准库目录开始搜索) 。 必须 【规则 3-3-4】用 #include “”格式来引用非标准库的头文件( 编译器将从用户的工作目录开始搜索) 。 必须 【规则 3-3-5】头文件中只存放“声明”而不存放“定义”。( 建议将成员函数的定义与声明分开, 不论该精品资料 - - - 欢迎下载 - - - - - - - - - - - 欢迎下载 名师归纳

20、 - - - - - - - - - -第 8 页，共 34 页 - - - - - - - - - - 嵌入式软件编程规范函数体有多么小。) 必须 【规则 3-4】源文件头部应进行注释, 列出 : 版权说明、版本号、作者、模块目的/ 功能、主要函数及其功能、修改日志等。 必须源文件模板示例:/* * (c) Copyright 2001-2005, TRZN, All Rights Reserved、 * THIS IS UNPUBLISHED PROPRIETARY SOURCE CODE OF TRZN, INC、 * The copyright notice above does no

21、t evidence any actual or intended * publication of such source code、 * * Subsystem: XXX * File: XXX_config、c * Author: Xxxxx * Description: Template for C source files、 * * /可选择的增加部分内容* Function List: /主要函数列表,每个函数一行,包含其返回值类型及参数类型。功能说明应当放在函数头注释中* 1、 、 * History: / 修改历史记录列表,每条修改记录应包括修改日期、修改 * / 者及修改内容

22、简述。( 参见底注 ) * 1、 Date: * Author: * Modification: * 2、 、* */ /*说明 :Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。 History就是修改历史记录列表,每条修改记录应包括修改日期、修改者及修改内容简述。*/ #include xxxxxx、h /* * * Function Name: XXX_Func1 * Input: Param1 - meaning; * Param2 - meaning; * Output: If theres no parameters for outp

23、ut, 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】函数头部应进行注释, 列出 :函数的目的 / 功能、输入参数、输出参数、返回值、调用关系( 函数、表 ) 等。 必须 函数注释模板示例: 精品资料 -

24、- - 欢迎下载 - - - - - - - - - - - 欢迎下载 名师归纳 - - - - - - - - - -第 9 页，共 34 页 - - - - - - - - - - 嵌入式软件编程规范/* * * 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 * Descri

25、ption: 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 Para

26、m2);【规则 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

27、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】注

28、释应与其描述的代码相近, 对代码的注释应放在其上方或右方( 对单条语句的注释) 相邻位置 , 不可放在下面;如放于上方则需与其上面的代码用空行隔开。 必须 示例 :如下例子不符合规范。精品资料 - - - 欢迎下载 - - - - - - - - - - - 欢迎下载 名师归纳 - - - - - - - - - -第 10 页，共 34 页 - - - - - - - - - - 嵌入式软件编程规范例 1( 错) :/* get replicate sub system index and net indicator */ rprRepssnInd = rprSsnDataindex、nRe

29、pssnIndex; 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; rprReps

30、snNi = 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】数据结构声明( 包括数组

31、、结构、类、枚举等) , 如果其命名不就是充分自注释的, 必须加以注释。对数据结构的注释应放在其上方相邻位置, 不可放在下面; 对结构中的每个域的注释放在此域的右方。 必须 示例 :可按如下形式说明枚举/ 数据 / 联合结构。/* 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 us

32、er 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 精品资料 - - - 欢迎下载 - - - - - - - - - - - 欢迎下载 名师归纳 - -

33、- - - - - - - -第 11 页，共 34 页 - - - - - - - - - - 嵌入式软件编程规范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 gG

34、TTranErrorCode; 【规则 3-13】代码中的特殊处理, 或者软件改变方案, 必须加注释 , 注明为何要这样做。 必须 说明 :只有加了注释,以后的维护者才有可能明白前因后果。【规则 3-14】注释与所描述内容进行同样的缩排。 必须 说明 :可使程序排版整齐,并方便注释的阅读与理解。示例 :如下例子 ,不正确的布局,排版不整齐 ,阅读稍感不方便。不正确的布局:void example_fun( void ) /* code one comments */ CodeBlock One /* code two comments */ CodeBlock Two 正确的布局 : void

35、 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 */ p

36、rogram code two 【规则 3-16】对变量的定义与分支语句( 条件分支、循环语句等) 必须编写注释。 建议 说明 :这些语句往往就是程序实现某一特定功能的关键,对于维护人员来说,良好的注释帮助更好的理解程序。【规则 3-17】对于 switch语句下的 case 语句 , 如果因为特殊情况需要处理完一个case 后进入下一个case 处理 , 必须在该 case 语句处理完、下一个case 语句前加上明确的注释。 必须 说明 :这样比较清楚程序编写者的意图,有效防止无故遗漏break语句。示例 (注意斜体加粗部分):case CMD_UP: ProcessUp(); break;

37、 case CMD_DOWN: ProcessDown(); break; case CMD_FWD: 精品资料 - - - 欢迎下载 - - - - - - - - - - - 欢迎下载 名师归纳 - - - - - - - - - -第 12 页，共 34 页 - - - - - - - - - - 嵌入式软件编程规范 ProcessFwd(); ProcessCFW_B(); /* now jump into case CMD_A */case CMD_A: ProcessA(); break; case CMD_B: ProcessB(); break; default: break;

38、 、【规则 3-18 】避免在一行代码或表达式的中间插入注释。 必须 说明 :除非必要 (如 PC-LINT 的行禁止检查标记),不应在代码或表达中间插入注释,否则容易使代码可理解性变差。【规则 3-19 】通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构, 使代码成为自注释的。 建议 说明 :清晰准确的函数、变量等的命名,可增加代码可读性,并减少不必要的注释。【规则 3-20 】代码的功能、意图层次上进行注释, 提供有用、额外的信息。 建议 说明 :注释的目的就是解释代码的目的、功能与采用的方法,提供代码以外的信息,帮助读者理解代码,防止没必要的重复注释信息。示例 : 如下注

39、释意义不大。/* if receive_flag is TRUE */ if (receive_flag)而如下的注释则给出了额外有用的信息。/* if mtp receive a message from links */ if (receive_flag)【规则 3-21 】在程序块的结束行右方加注释标记, 以表明某程序块的结束。 可选 说明 :当代码段较长,特别就是多重嵌套时,这样做可以使代码更清晰,更便于阅读。在Source Insight 软件中可以自动显示这类信息。示例 :参见如下例子。精品资料 - - - 欢迎下载 - - - - - - - - - - - 欢迎下载 名师归纳

40、- - - - - - - - - -第 13 页，共 34 页 - - - - - - - - - - 嵌入式软件编程规范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-1 】标识符的命名要清晰、明了, 有明确含义

41、, 同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解。 建议 说明 :较短的单词可通过去掉“元音”形成缩写;较长的单词可取单词的头几个字母形成缩写;一些单词有大家公认的缩写。示例 :如下单词的缩写能够被大家基本认可。temp 可缩写为 tmp; flag 可缩写为 flg; statistic 可缩写为 stat; increment 可缩写为 inc; decrease 可缩写为 dec; message 可缩写为 msg; reserve 可缩写为 resv; receive 可缩写为 rec; 【规则 4-2 】命名中若使用特殊约定或缩写, 则要有注释说明。 必须 说明 :应

42、该在源文件的开始之处,对文件中所使用的缩写或约定,特别就是特殊的缩写,进行必要的注释说明。【规则 4-3 】自己特有的命名风格, 要自始至终保持一致, 不可来回变化。 建议 说明 :个人的命名风格,在符合所在项目组或产品组的命名规则的前提下,才可使用。 (即命名规则中没有规定到的地方才可有个人命名风格)。【规则 4-4 】常量的定义全部采用大写单词, 单词中间以下划线分开, 并且各模块中的常量第一个单词必须为模块头 , 定义的常数必须加括号。 必须 示例 : #define RPR_STATUS_CALLBACK (1) 精品资料 - - - 欢迎下载 - - - - - - - - - -

43、- 欢迎下载 名师归纳 - - - - - - - - - -第 14 页，共 34 页 - - - - - - - - - - 嵌入式软件编程规范#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, exc

44、luding 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

45、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 】变量名中的大小写与分隔: 使用单词首字母大写作为变量中各单词的间隔, 变量的打头字

46、母、打头单词必须小写, 禁止使用下划线( “ _” ) 做变量中的分割符。 必须 例如 : UINT32 dccResetAddr; STATUS rprInstStatus; 【规则 4-9 】全局变量的头部必须有“ g+subsystem ” 的标记 , 用于区分全局变量的模块范围, 同时防止重名。相同模块内的全局变量必须尽量放在同一个文件中。 必须 精品资料 - - - 欢迎下载 - - - - - - - - - - - 欢迎下载 名师归纳 - - - - - - - - - -第 15 页，共 34 页 - - - - - - - - - - 嵌入式软件编程规范例如 : UINT8

47、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

48、; 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 】 变量的前缀表示方法 必须 类型描述前缀举例* 指针p UINT8 *pucIndex; 定长数组a (optional) UINT8 aMyVarMAX_

49、LEN; BOOL 布尔值b BOOL bMonitored; char 字符串s char sTtiTx64; UINT8 8-bit 无符号整数uc (optional) UINT8 ucIndex; or UINT8 index; UINT16 16-bit 无符号整数us (optional) UINT16 usPort; or UINT16 port; UINT32 32-bit 无符号整数ul (optional)UINT32 ulErrorCode; char 可显示字符c (optional)char cHexHigher4Bits, cHexLower4Bits; int 依

50、赖于操作系统的不定长整数(不建议使用 ) 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(Co