大型项目开发: 头文件顺序

原创 2015年07月09日 00:25:17

经验告诉我们,某些编码实践虽然在C++中完全合法,但是绝对不能应用于大型项目环境中。 大型项目环境下必须有适当的约束,否则很容易变得难以控制并很难维护(摘自<<大规模C++程序设计>>)。下面以Chromium中运用的两个Coding Style中定义的头文件顺序为例。

头文件顺序的差异

WebKit/Blink遵循业界标准的定义,其实也是Lakos在<<大规模C++程序设计>>中建议的顺序 :

  1. 编译单元对应的头文件 (Related header file)。
  2. 工程内的其它头文件。
  3. 库及系统头文件。

(Blink特殊的一点是编译单元必须先包含config.h。)

这样做的目的是为避免隐性依赖。每个头文件都应当做到自包含(Self-Contained, or Self Sufficient), 这样保证用户能直接头文件中理解它的物理依赖。如果遵循这个顺序,当出现隐性依赖时,是无法编译通过的。

下面这个例子:
my_class.h中依赖了std::string, 但没有显式的包含,当main里先包含标准库的头文件string时,编译是不会出错的。

main.cc

#include <string>
#include <iostream>
#include "my_class.h"

int main(int argc, char* argv[]) {
  MyClass aInstance;
  std::cout << aInstance.value() << std::endl;
}

my_class.h

#ifndef MY_CLASS_H_
#define MY_CLASS_H_
class MyClass {
 public:
  MyClass();
  const std::string& value();
 private:
  std::string value_;
};
#endif

如果遵循上面的规则,就会在编译main.cc时报错:

In file included from main.cc:1:
./my_class.h:6:9: error: use of undeclared identifier 'std'
  const std::string& value();

在一个层次更为清晰的项目下,错误最好归属到作者身上。这里main.cc做为my_class.h的用户,这样的错误最好由my_class.h的作者来解决。所以Google定义了如下的规则:
关联的头文件
C库头文件
C++库头文件
其它库头文件
* 项目中的其它头文件。
实现如下的my_class.cc时就会收到报错:
my_class.cc
#include "my_class.h"
#include <string>


MyClass::MyClass()
  :value_("Hello!") {
}

在这种情况下,这个错误将只报给my_class.h对应的编译单元my_class.cc。
In file included from my_class.cc:1:
./my_class.h:6:9: error: use of undeclared identifier 'std'
  const std::string& value();

如果是一个小项目,可能察觉不到这样做的差异。但在讲求职责清晰,分工协作的大型项目下,它就会变得很有价值。
这是一个很小的点,可见大型项目中一些规则定义的冰山一角。再比如大型项目中的头文件还有一些设计上的权衡。比如避免不必要包含头文件会拖慢项目的构建效率,引入了前置声明。但它却在一些场景下会造成歧义(比如前置声明标准库中的类,或者模板类),或者引入一些的维护成本和风险(比如函数的参数变化,需要对应修改前置声明)。Google早期是鼓励使用前置声明,而现在只是强调在明确带来好处的情况下才建议使用前置声明。

扩展阅读:

Self-sufficient header files in C/C++
Headers and Includes: Why and How
C/C++ include file order/best practices

版权声明:本文为博主原创文章,未经博主允许不得转载。

相关文章推荐

C++编程规范之23:头文件应该自给自足

摘要:     各司其责:应该确保所编写的每个头文件都能够独自进行编译,为此需要包含其内容所依赖的所有头文件。 如果一个文件包含某个头文件时,还要包含另一个头文件才能工作,就会增加交流障碍,给头文件的...

【Flask】在PyCharm上组织Flask大型项目文件结构

要想用Flask开发大型项目,就必须要有良好的项目文件结构,这篇文章主要记录Flask最小开发项目的配置。这里所使用的Python版本为3.5.1,Flask版本为0.11.1。

开发维护大型项目的Java的建议

开发维护大型项目的Java的建议.txt开发维护大型项目的Java的建议.txt1、不要试图一下子搞懂整个项目2、关注于尽快交付价值有效的单元测试用例是理解大型项目代码的很好途径 写一些笔记,或者画一...

大型项目开发:谨慎使用智能指针

智能指针使用上的问题智能指针的使用太普遍了,它让程序员摆脱了内存管理的恶梦,但实际上智能指针本身也可能引入另一个恶梦。主要包括两个问题点: 1.性能问题。因为需要引入一些变量(bookkeeping)...

给开发维护大型项目开发者的建议

假设你是正在开发和维护一个包含2000个类并使用了很多框架的Java开发人员。你要如何理解这些代码?在一个典型的Java企业项目小组中,大部分能够帮你的高级工程师看起来都很忙。文档也很少。你需要尽快交...

iOS 大型项目开发漫谈

来源:CrespoXiao的简书 作者:CrespoXiao 标题有些吓人请不要害怕,不过这确实不是扫盲贴,需要一定的iOS开发基础。在我多年的码农生涯中绝大部分时间都是做的小项目,...

给开发维护大型项目开发者的建议【转】

假设你是正在开发和维护一个包含2000个类并使用了很多框架的Java开发人员。你要如何理解这些代码?在一个典型的Java企业项目小组中,大部分能够帮你的高级工程师看起来都很忙。文档也很少。你需要尽快交...

给开发维护大型项目开发者的建议

from : http://kb.cnblogs.com/page/137407/   英文原文:Tips to Developers Starting on Large App...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:深度学习:神经网络中的前向传播和反向传播算法推导
举报原因:
原因补充:

(最多只允许输入30个字)