嵌入式软件编程规范[参考].docx

TRZN 嵌入式软件编程规范 文档修正前史： 版别号 日期 修正者及常用邮箱 修正日志 0.1 2016-10-28 杨科ykee126@126.com 根据查阅的相关材料收拾, 此版别为榜首次提交。 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]高质量C++编程 [2]Effective C++ [3]More Effective C++ [4]C++ Primer [5]Thinking in C++ 排版 【规矩 2-1】程序块要选用缩进风格编写, 缩进的空格数为4个,对齐运用空格键, 不得运用TAB键。[有必要]嵌入式软件开发的代码编辑器, 引荐运用Keil uVision5, 编辑器参数设置见附录A。 【规矩 2-2】相对独立的程序块之间、变量阐明之后有必要加空行。[有必要]示例： 不正确的书写办法：if (!rpr_valid_ni(ni)){ ... // program code}gRprRepssnInd = gRprSsnData[idx].repssn_index;gRprRepssnNi = gRprSsnData[idx].ni; 正确的书写办法:if (!rpr_valid_ni(ni)){ ... // program code}//空行gRprRepssnInd = gRprSsnData[idx].repssn_index;gRprRepssnNi = gRprSsnData[idx].ni; 【规矩 2-3】较长的句子（80字符）要分红多行书写, 长表达式要在低优先级操作符处区别新行, 操作符放在新行之首, 区别出的新行要进行恰当的缩进, 使排版规整, 句子可读。[有必要]示例： gRprPermCountMsg.head.len = RPR_NO7_TO_STAT_PERM_COUNT_LEN +RPR_STAT_SIZE_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 (statItem)) (0 != gSYSActTaskTable[taskno].resultData)); 【规矩 2-4】循环、判别等句子中若有较长的表达式或句子, 则要进行恰当的分行, 长表达式要在低优先级操作符处区别新行, 操作符放在行尾。[有必要]示例： if ((taskno gSysMaxActTaskNumber) (SYS_n7statStatItemValid (statItem))){... // program code}//空行for (i = 0, j = 0;(i rprBufferKeyword[wordIndex].nWordLength) (j rprNewKeyword.nWordLength); i++, j++){... // program code}//空行for (i = 0, j = 0;(i rprFirstWordLengt