CC++代码编码规范.pdf

XX企业

CC++代码编码规范

信息科技部

20xx年xx月

1

目录

1.概述8

1.1.目的8

1.2.适用范围8

2.排版要求8

2.1.程序块缩进8

2.2.程序块之间空行8

2.3.长语句和长表达式9

2.4.循环、判断等长表达式或语句10

2.5.长参数10

2.6.短语句10

2.7.条件、循环语句11

2.8.语句对齐11

2.9.函数、过程和结构等语句块11

2.10.程序块分界符11

2.11.操作符前后空格12

2.12.其他14

3.注释14

3.1.有效注释量14

3.2.公司标识14

3.3.说明性文件15

3.4.源文件头15

3.5.函数头部说明16

3.6.注释与代码一致17

3.7.注释内容17

3.8.注释缩写17

3.9.注释位置17

2

3.10.变量、常量注释18

3.11.数据结构的注释18

3.12.全局变量19

3.13.注释缩排19

3.14.注释与代码之间空行20

3.15.变量定义、分支语句20

3.16.其他22

4.标识符命名23

4.1.命名清晰23

4.2.特殊命名需注释24

4.3.命名风格保持一致24

4.4.变量命名24

4.5.命名规范与系统风格一致25

4.6.其他25

5.可读性27

5.1.运算符优先级27

5.2.避免直接使用数字作为标识符28

5.3.其他28

6.变量、结构29

6.1.公共变量29

6.2.公共变量说明29

6.3.公共变量访问说明30

6.4.公共变量赋值30

6.5.防止局部变量与公共变量同名30

6.6.严禁使用未经初始化的变量作为右值31

6.7.其他31

7.函数、过程38

3

7.1.对所调用函数的错误返回码要仔细、全面地处理38

7.2.明确函数功能，精确（而不是近似）地实现函数设计38

7.3.局部变量38

7.4.全局变量39

7.5.接口函数参数40

7.6.其他40

8.可测性50

8.1.调测开关50

8.2.打印信息50

8.3.单元测试51

8.4.集成测试51

8.5.断言使用51

8.6.版本维护54

8.7.其他55

9.程序效率56

9.1.编程时要经常注意代码的效率56

9.2.提高代码效率57

9.3.提高代码空间效率57

9.4.循环体内工作量最小化58

9.5.其他59

10.质量保证62

10.1.在软件设计过程中构筑软件质量62

10.2.代码质量保证优先原则62

10.3.只引用属于自己的存贮空间62

10.4.防止引用已经释放的内存空间62

10.5.文件句柄及时关闭63

10.6.防止内存操作越界64

4

10.7.认真处理程序所能遇到的各种出错情况65

10.8.初始化变量65

10.9.数据一致性检查65

10.10.严禁随意更改其它模块或系统的有关设置和配置65

10.11.不能随意改变与其它模块的接口65

10.12.系统接口65

10.13.编程时，要防止差1错误67

10.14.操作符检查67

10.15.分支语句写完整68

10.16.使用return语句68

10.17.不要滥用goto语句68

10.18.其他68

11.代码编辑、编译、审查71

11.1.打开编译器的所有告警开关对程序进行编译71

11.2.在产品软件（项目组）中，要统一编译开关选项71

11.3.通过代码走读及审查方式对代码进行检查71

11.4.测试部测试产品之前，应对代码进行抽查及评审71

11.5.其他71

12.代码测试、维护73

12.1.单元测试要求至少达到语句覆盖73

12.2.单元测试开始要跟踪每一条语句，并观察数据流及变量的变化73

12.3.清理、