嵌入式软件编程规范[52页]

《嵌入式软件编程规范[52页]》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、个人收集整理勿做商业用途封面作者：ZHANGJIAN仅供个人学习，勿做商业用途52/52个人收集整理勿做商业用途TRZN嵌入式软件编程规范52/52个人收集整理勿做商业用途文档修改历史：版本号日期修改者及常用邮箱修改日志0.12016-10-28杨科ykee126@126.com根据查阅的相关资料整理，此版本为第一次提交。52/52个人收集整理勿做商业用途1文档概述4文档来自于网络搜索1.1关于本文档4文档来自于网络搜索1.2参考文献4文档来自于网络搜索2排版5文档来自于网络搜索3注释10文档来自于网络搜索4标识符命名19文档来自于网络搜索5可读性25文档来自于网络搜索6变量、结构

2、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.1KeiluVision5默认配置修改46文档来自于网络搜索52/52个人收集整理勿做商业用途1文档概述1.1关于本文

3、档本文档规范了芜湖天人智能有限公司嵌入式软件部软件代码的书写规范和原则。本文档仅供公司内部员工使用。公司机密，严禁外传。本文档中各规则的格式如下：【规则编号】[规则内容][[标记]]其中[标记]的含义如下：（必须）：表示该条规则是必须遵守的。（建议）：表示该条规则是建议遵守的。（可选）或没有标记：表示该条规则是可选择遵守的。本文档的示例中，如有使用“//”，并非代码注释，而是文档的注释(有可能是文档中对代码注释的解释)。1.2参考文献[1]高质量C++编程[2]EffectiveC++[3]MoreEffectiveC++[4]C++Primer[5]ThinkinginC++52

4、/52个人收集整理勿做商业用途1排版l【规则01】程序块要采用缩进风格编写，缩进的空格数为4个,对齐使用空格键，不得使用TAB键。[必须]文档来自于网络搜索嵌入式软件开发的代码编辑器，推荐使用KeiluVision5，编辑器参数设置见附录A。l【规则02】相对独立的程序块之间、变量说明之后必须加空行。[必须]文档来自于网络搜索示例：不正确的书写方式：if(!rpr_valid_ni(ni)){...//programcode}gRprRepssnInd=gRprSsnData[idx].repssn_index;gRprRepssnNi=gRprSsnData[idx].ni;

5、正确的书写方式:if(!rpr_valid_ni(ni)){...//programcode}//空行gRprRepssnInd=gRprSsnData[idx].repssn_index;gRprRepssnNi=gRprSsnData[idx].ni;l【规则03】较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。[必须]文档来自于网络搜索示例：gRprPermCountMsg.head.len=RPR_NO7_TO_STAT_PERM_COUNT_LEN+RPR_STAT_S

6、IZE_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(statIt

7、em))&&(0!=gSYSActTaskTable[taskno].resultData));l【规则04】循环、判断等语句中若有较长的表达式或语句，则要进行适当的分行，长表达式要在低优先级操作符处划分新行，操作符放在行尾。[必须]文档来自于网络搜索示例：52/52个人收集整理勿做商业用途if((taskno