- 1、原创力文档(book118)网站文档一经付费(服务费),不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。。
- 2、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。如您付费,意味着您自己接受本站规则且自行承担风险,本站不退款、不进行额外附加服务;查看《如何避免下载的几个坑》。如果您已付费下载过本站文档,您可以点击 这里二次下载。
- 3、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“版权申诉”(推荐),也可以打举报电话:400-050-0827(电话支持时间:9:00-18:30)。
- 4、该文档为VIP文档,如果想要下载,成为VIP会员后,下载免费。
- 5、成为VIP后,下载本文档将扣除1次下载权益。下载后,不支持退款、换文档。如有疑问请联系我们。
- 6、成为VIP后,您将拥有八大权益,权益包括:VIP文档下载权益、阅读免打扰、文档格式转换、高级专利检索、专属身份标志、高级客服、多端互通、版权登记。
- 7、VIP文档为合作方或网友上传,每下载1次, 网站将根据用户上传文档的质量评分、类型等,对文档贡献者给予高额补贴、流量扶持。如果你也想贡献VIP文档。上传文档
查看更多
软件编写规范
软件编写规范
V1.0
2008-8-16
第 1 页 共 72 页
目录
第 1 章 排版 3
1.1 程序块 3
1.2 长句 4
1.3 变量赋值语句 5
1.4 关键字 6
1.5 对齐方式 6
1.6 缩进 6
1.7 代码的清晰原则 8
第 2 章 注释 10
2.1 说明性文件 10
2.2 代码的注释 12
2.3 变量及结构的注释 15
2.4 注释的排版 16
2.5 编制注释的建议 17
第 3 章 标识符的命名 20
3.1 命名原则 20
3.2 命名中的建议 21
第 4 章 可读性 23
第 5 章 变量及结构的定义 26
5.1 定义规则 26
5.2 定义中的注意点 27
第 6 章 函数及过程的定义 35
6.1 函数及过程的设计规范 35
6.2 编写函数及过程的建议措施 36
第 7 章 可测性 47
7.1 规范 47
7.2 建议措施 50
第 8 章 程序效率 53
8.1 规范 53
8.2 建议 55
第 9 章 质量保证 59
9.1 规范 59
9.2 建议 64
第 10 章 代码编辑、编译、审查 68
10.1 规范 68
10.2 建议 68
第 11 章 代码测试、维护 70
11.1 规范 70
11.2 建议 70
第 12 章 宏 71
12.1 定义规则 71
第 2 页 共 72 页
第 1 章 排版
1.1 程序块
1.程序块要采用缩进风格编写,缩进的空格数为 4 个
说明:对于由开发工具自动生成的代码可以有不一致。
2.相对独立的程序块之间、变量说明之后必须加空行
示例:如下例子不符合规范。
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
应如下书写
if (!valid_ni(ni))
{
... // program code
}
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
第 3 页 共 72 页
1.2 长句
1.较长的语句(80 字符)要分成多行书写,长表达式要在低优先级操作符处
划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整
齐,语句可读
示例:
perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN
+ STAT_SIZE_PER_FRAM * sizeof( _UL );
act_task_table[frame_id * STAT_TA
原创力文档


文档评论(0)