- 1、本文档共43页,可阅读全部内容。
- 2、有哪些信誉好的足球投注网站(book118)网站文档一经付费(服务费),不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
- 3、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。如您付费,意味着您自己接受本站规则且自行承担风险,本站不退款、不进行额外附加服务;查看《如何避免下载的几个坑》。如果您已付费下载过本站文档,您可以点击 这里二次下载。
- 4、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“版权申诉”(推荐),也可以打举报电话:400-050-0827(电话支持时间:9:00-18:30)。
查看更多
TRZN
TRZN 嵌入式软件编程规范
1 / 43
文档修改历史:
版本号 日期 修改者及常用邮箱 修改日志
杨科
0.1 2016-10-28 根据查阅的相关资料整理,此版本为第一次提交。
ykee126@126.com
2 / 43
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.2 GIT 分支定义 44
10.3 GIT 代码引入规定 44
10.4 GIT 代码 COMMIT 顺序45
10.5 COMMIT 文件过程中的其他注意事项45
11 附录A – 推荐编辑器的默认配置修改 46
11.1 KEIL UVISION5 默认配置修改46
3 / 43
1 文档概述
1.1 关于本文档
本文档规范了芜湖天人智能有限公司嵌入式软件部软件代码的书写规范和原则。
本文档仅供公司内部员工使用。
公司机密,严禁外传。
本文档中各规则的格式如下:
【规则 编号】 [规则内容] [[标记]]
其中[标记]的含义如下:
(必须) :表示该条规则是必须遵守的。
(建议) :表示该条规则是建议遵守的。
(可选)或没有标记:表示该条规则是可选择遵守的。
本文档的示例中,如有使用 “// ”,并非代码注释,而是文档的注释(有可能是文档中对代码注释的解释) 。
1.2 参考文献
[1]高质量 C++编程
[2]Effective C++
[3]More Effective C++
[4]C++ Primer
[5]Thinking in C++
4 / 43
2 排版
【规则 2-1】程序块要采用缩进风格编写,缩进的空格数为4个,对齐使用空格键,不得使用TAB键。
[必须]
嵌入式软件开发的代码编辑器,推荐使用 Keil uVision5 ,编辑器参数设置见附录A 。
【规则 2-2】相对独立的程序块之间、变量说明之后必须加空行。[必须]
示例:
不正确的书写方式: 正确的书写方式:
if (!rpr_valid_ni(ni)) if (!rpr_valid_ni(ni))
{ {
... // program code ... // program code
} }
gRprRepssnInd //空行
= gRprSsnData[idx].repssn_index; gRprRepssnInd
gRprRepssnNi = gRprSsnData
文档评论(0)