2022年嵌入式软件编程规范.pdf
《2022年嵌入式软件编程规范.pdf》由会员分享,可在线阅读,更多相关《2022年嵌入式软件编程规范.pdf(34页珍藏版)》请在得力文库 - 分享文档赚钱的网站上搜索。
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
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 2022 嵌入式 软件 编程 规范
限制150内