C与C++编码规范


目录

1.   文件结构.. 1

1.1   版权和版本的声明格式.. 1

1.2   头文件的书写格式.. 1

2.   程序的版式.. 4

2.1   空行的使用.. 4

2.2   代码行.. 4

2.3   代码行内的空格.. 5

2.4   对齐.. 6

2.5   长行拆分.. 7

2.6   修饰符的位置.. 7

2.7   注释.. 7

3.   命名规则.. 10

3.1   共性规则.. 10

3.2   Windows 程序命名规则.. 11

4.   表达式和基本语句.. 14

4.1   运算符的优先级.. 14

4.2   表达式与复合表达式.. 14

4.3   if语句.. 15

4.4   循环语句的效率.. 17

4.5   for语句的循环控制变量.. 17

4.6   switch 语句.. 18

4.7   goto 语句.. 18

5.   数据结构.. 19

5.1   基本规则.. 19

6.   常量.. 21

6.1   常量的命名规则.. 21

6.2   常量的使用.. 21

6.3   常量定义规则.. 21

6.4   C++类中的常量.. 22

7.   函数(操作)设计.. 23

7.1   函数外部特性的注释规则.. 23

7.2   参数的规则.. 23

7.3   返回值的规则.. 25

7.4   函数内部的实现规则.. 26

7.5   其它规范.. 28

8.   内存管理.. 29

8.1   基本原理.. 29

8.2   基本规则.. 30

9.   代码可测性.. 31

9.1   基本规则.. 31

9.2   编辑、编译、审查.. 32

9.3   代码测试.. 33

10.源代码升级.. 35

10.1  基本规则.. 35

11.其它规则和建议.. 37

11.1  其它规则.. 37

11.2  其它建议.. 38

 

每个C++/C 程序通常分为两个文件。一个文件用于保存程序的声明(declaration),称为头文件。另一个文件用于保存程序的实现(implementation),称为定义(definition)文件。C++/C 程序的头文件以“.h”为后缀,C 程序的定义文件以“.c”为后缀,C++程序的定义文件通常以 “.cpp”为后缀(也有一些系统以“.cc”或“.cxx”为后缀)。对于 DLL 文件,通常还包括“.def”文件。

头文件和 C 程序文件中都必须包含版权和版本的声明。

版权和版本的声明位于头文件和定义文件的开头(参见示例 1-1),主要内容有:

1.     版权信息。

2.     文件名称、标识符、摘要。

3.     当前版本号、作者/修改者、完成日期。

4.     版本历史信息。

示例1‑1版权和版本的声明范例

头文件的作用:通过头文件来调用库功能。在很多场合,源代码不便(或不准)向用户公布,只要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功能,而不必关心接口怎么实现的。编译器会从库中提取相应的代码。头文件能加强类型安全检查。如果某个接口被实现或被使用时,其方式与头文件中的声明不一致,编译器就会指出错误,这一简单的规则能大大减轻程序员调试、改错的负担。

1.     头文件必须包含下列内容:

1.1.  头文件开头处的版权和版本声明。

1.2.  预处理块。

1.3.  函数和类结构声明等。

2.     正确使用预处理块:为了防止头文件被重复引用,应当用 ifndef/define/endif 结构产生预处理块。

3.     正确引用头文件的格式:用 #include <filename.h> 格式来引用标准库的头文件(编译器将从标准库目录开始搜索),用 #include “filename.h” 格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索)。

4.     头文件中只存放“声明”而不存放“定义”

5.     在 C++ 语法中,类的成员函数可以在声明的同时被定义,并且自动成为内联函数。这虽然会带来书写上的方便,但却造成了风格不一致,弊大于利。建议将成员函数的定义与声明分开,不论该函数体有多么小。

6.     不提倡使用全局变量,尽量不要在头文件中出现像 extern int value 这类声明。

示例1‑2 C++/C 头文件的结构范例

7.     定义文件的书写格式:必须包含三部分内容:

7.1.  定义文件开头处的版权和版本声明;

7.2.  对一些头文件的引用;

7.3.  程序的实现体(包括数据和代码)。

假设定义文件的名称为 graphics.cpp,定义文件的典型结构为:

 


示例1‑3 C++/C 定义文件的结构范例


版式虽然不会影响程序的功能,但会影响可读性。程序的版式追求清晰、美观,是程序风格的重要构成因素。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值