1. #define的保护
所有头文件都应该使用#define 防止头文件被多重包含(multiple inclusion),命名格式
当是:<PROJECT>_<PATH>_<FILE>_H_
为保证唯一性,头文件的命名应基于其所在项目源代码树的全路径。例如,项目foo 中的头
文件foo/src/bar/baz.h 按如下方式保护:
#ifndef FOO_BAR_BAZ_H_
#define FOO_BAR_BAZ_H_
...
#endif // FOO_BAR_BAZ_H_
2. 头文件依赖
使用前置声明(forward declarations)尽量减少.h 文件中#include 的数量。
当一个头文件被包含的同时也引入了一项新的依赖(dependency),只要该头文件被修改,
代码就要重新编译。如果你的头文件包含了其他头文件,这些头文件的任何改变也将导致那
些包含了你的头文件的代码重新编译。因此,我们宁可尽量少包含头文件,尤其是那些包含
在其他头文件中的。
使用前置声明可以显著减少需要包含的头文件数量。举例说明:头文件中用到类File,但不
需要访问File 的声明,则头文件中只需前置声明class File;无需#include
"file/base/file.h"。
在头文件如何做到使用类Foo 而无需访问类的定义?
1) 将数据成员类型声明为Foo *或Foo &;
2) 参数、返回值类型为Foo 的函数只是声明(但不定义实现);
3) 静态数据成员的类型可以被声明为Foo,因为静态数据成员的定义在类定义之外。
另一方面,如果你的类是Foo 的子类,或者含有类型为Foo 的非静态数据成员,则必须为
之包含头文件。
有时,使用指针成员(pointer members,如果是scoped_ptr 更好)替代对象成员(object
members)的确更有意义。然而,这样的做法会降低代码可读性及执行效率。如果仅仅为
了少包含头文件,还是不要这样替代的好。
当然,.cc 文件无论如何都需要所使用类的定义部分,自然也就会包含若干头文件。
译者注:能依赖声明的就不要依赖定义。
以上是Google中C++编程规范的前两条要求。第一条相信大家都知道。第二条就是我要说的问题了。
这里我用VS2012解释下这个事情。要减少编译的目的就是要减少#include;
那我们先定义这样两个类:
#pragma once class A { public: A(void); ~A(void); };
#pragma once #include "A.h" class B { public: B(void); ~B(void); private: A a; };
可以看到这是很简单的组合类的情况。B类中有个A的对象。下面我们生成一下。
这时候A,B第一次编译成功
接下来我们修改对象A,在对象A中增加一个私有成员i,B不变;
#pragma once class A { public: A(void); ~A(void); private: int i; };
这时候再生成一次,可以看到如下情况
可以看到A编译后。编译器发现B中导入了A.h然后又编译了一次B。
在工程量比较小的时候这么做是没关系的。但当你编译一次代码需要1分钟2分钟的时候。我们频繁的修改源码然后编译你会崩溃的是不是?
所以前置声明是一个可以选择的解决方案。
B的代码只要做如下修改,取消导入A.h在B.h中声明class A;
#pragma once class A; class B { public: B(void); ~B(void); private A* a; };
我们同样在A没修改之前做一次编译。
同样我们在A中加入私有成员后再编译一次。
可以看到这里只编译了A.cpp文件。
这种原因就是其实是C++的声明与定义并未完全分离的缘故。像Java就不会有这种问题=。=