前言

我并不认为深刻理解了很多事情，但是实际上在项目中试着使用了一下，发现了问题。我以为自己写c语言已经习惯用小型汽车了，特别是在软件文件的工程管理方面，我对自己的代码编写风格很有信心。 (毕竟，刚毕业时老板对我的画笔训练是编码格式的规范化处理)

我本以为一个. c文件对应一个. h文件， c文件只需要包含其自己的. h文件，但如果. c文件包含其他文件的内容， h文件将包含要使用的头文件自己好像一直继承着这个理念做代码(很害怕)。在工程文件数量少的时候，这个理念似乎看起来不像问题，但是随着工程文件的数量增加，头文件相互包含，所以在编译时如果声明了一些宏变量，实际上就会起作用。

经过领导和同事的指出，我明白了原来的代码编写习惯是不正确的。与. c文件对应的. h文件应只包含头文件中使用的其他文件的头文件，而不包含在非必需的. h文件中。 c文件包含要使用的所有. h文件。这样写的话，即使重复包含. c文件内的头文件也没有影响。

语言的解释有时太抽象，有时用符号的例子来说明。如果两个. c文件分别是A.c和B.c，则当然会有各自的A.h和B.h文件。

以往的想法： A.c中只有一个#include 'A.h '，A.h中包含了大量的文件，如B.h、C.h、D.h……。因为在A.c文件中会使用B.h、C.h、d.h的内容。如图1所示。

新思路： A.h只包含用于A.h所写内容的. h文件。在大多数情况下，A.h不需要. h文件。 A.c文件写着#包括' b.h ' #包括' c.h ' #包括' d.h '。另外，两个文件的. c文件可以包含在头文件的包含中。如图2所示。

项目中遇到的这个头文件包含问题，我重新搜索了资料对这个问题进行了深入的了解，以下是互联网资源的搜索，加上自己对它的了解，希望对相关内容的整理，有所帮助。

关于

背景

语言，头文件的设计体现了大部分的系统设计。不合理的头文件放置是编译时间过长的原因，不合理的头文件实际上设计得不合理。

依赖

特别是依赖于编译。如果x.h包含y.h，则称为x依赖y。依存关系被传达。例如，如果x.h包含y.h，而y.h包含z.h，则x通过y依赖于z。依赖会导致编译时间的上升。依赖是不可避免的，也是必须的，但在糟糕的设计中，整个系统的依赖关系变得非常复杂，任何一个文件的修改都必须重新编译整个系统，编译时间大幅上升。

在设计良好的系统中，要修改一个文件，只需要重新编译多个文件，甚至一个文件。

一个产品曾进行过一个实验，用工具注释掉所有函数的实现，将编译时间缩短到不到10%。其理由是，a包含b、b包含c、c包含d，最终几乎所有源文件都包含项目组的所有头文件，因此编译时间的大部分都花在了头文件的分析上。

一些产品具有“卓越的实践”，通过工具将. c文件合并为较大的. c文件，从而大大提高编译效率。根本原因是通过合并. c文件减少了头文件的分析次数。但是，这样的“优秀实践”是对. c文件进行合理分类的破坏。

大多数产品需要编译整个项目才能修改一个位置的代码。 TDD等实践要求将模块级编译时间控制在秒级，即使使用分布式编译也很难实现。最终，必须合理划分头文件和头文件之间的包含关系，从根本上缩短编译时间。

《google C++ Style Guide》 1.2头文件相关的章中也进行了同样的说明：

如果包含头文件aa.h，则会引入一种新的依赖关系，即如果aa.h发生更改，则直接和间接包含的aa.h代码将被重新编译。如果aa.h包含其他头文件(如bb.h )，则对bb.h的修改会重新编译包括aa.h在内的所有代码，而敏捷开发方法会频繁生成代码，较长的编译时间会严重阻碍频繁生成。因此，为了控制代码更改后的编译时间，通常会减少头文件，特别是头文件中的包含。

的头文件分割体现了系统设计的思想，但从编程规范的角度看，合理规划头文件的通用方法还有很多。本章介绍的一些方法有助于合理规划头文件。

原则1.1 )适合在头文件中放置接口的声明不适合放置实现。

说明：头文件是模块(Module )或单元)的对外接口。头文件必须包含外部声明，如外部提供的函数声明、宏定义等

、类型定义等。

内部使用的函数（相当于类的私有方法）声明不应放在头文件中。内部使用的宏、枚举、结构定义不应放入头文件中。变量定义不应放在头文件中，应放在.c文件中。变量的声明尽量不要放在头文件中，亦即尽量不要使用全局变量作为接口。变量是模块或单元的内部实现细节，不应通过在头文件中声明的方式直接暴露给外部，应通过函数接口的方式进行对外暴露。

延伸阅读材料：《 C语言接口与实现》

原则1.2：头文件应当职责单一。

说明：头文件过于复杂，依赖过于复杂是导致编译时间过长的主要原因。很多现有代码中头文件过大，职责过多，再加上循环依赖的问题，可能导致为了在.c中使用一个宏，而包含十几个头文件。

某个头文件不但定义了基本数据类型WORD，还包含了stdio.h syslib.h等等不常用的头文件。如果工程中有10000个源文件，而其中100个源文件使用了stdio.h的printf，由于上述头文件的职责过于庞大，而WORD又是每一个文件必须包含的，从而导致stdio.h/syslib.h等可能被不必要的展开了9900次，大大增加了工程的编译时间。

原则1.3：头文件应向稳定的方向包含。

说明：头文件的包含关系是一种依赖，一般来说，应当让不稳定的模块依赖稳定的模块，从而当不稳定的模块发生变化时，不会影响（编译）稳定的模块。

就我们的产品来说，依赖的方向应该是：产品依赖于平台，平台依赖于标准库。某产品线平台的代码中已经包含了产品的头文件，导致平台无法单独编译、发布和测试，是一个非常糟糕的反例。

除了不稳定的模块依赖于稳定的模块外，更好的方式是两个模块共同依赖于接口，这样任何一个模块的内部实现更改都不需要重新编译另外一个模块。在这里，我们假设接口本身是最稳定的。

延伸阅读材料：编者推荐开发人员使用“依赖倒置”原则，即由使用者制定接口，服务提供者实现接口，更具体的描述可以参见《敏捷软件开发：原则、模式与实践》（ Robert C.Martin 著朴实的金毛译清华大学出版社2003年9月）的第二部分“敏捷设计”章节。

规则1.1：每一个.c文件应有一个同名.h文件，用于声明需要对外公开的接口。

说明：如果一个.c文件不需要对外公布任何接口，则其就不应当存在，除非它是程序的入口，如main函数所在的文件。

现有某些产品中，习惯一个.c文件对应两个头文件，一个用于存放对外公开的接口，一个用于存放内部需要用到的定义、声明等，以控制.c文件的代码行数。编者不提倡这种风格。这种风格的根源在于源文件过大，应首先考虑拆分.c文件，使之不至于太大。另外，一旦把私有定义、声明放到独立的头文件中，就无法从技术上避免别人include之，难以保证这些定义最后真的只是私有的。

本规则反过来并不一定成立。有些特别简单的头文件，如命令ID定义头文件，不需要有对应的.c存在[a1] 。

示例：对于如下场景，如在一个.c中存在函数调用关系：

void foo() { bar(); } void bar() { Do something; }

必须在foo之前声明bar，否则会导致编译错误。

这一类的函数声明，应当在.c的头部声明，并声明为static的，如下：

static void bar(); void foo() { bar(); } void bar() { Do something; }

规则1.2：禁止头文件循环依赖。

说明：头文件循环依赖，指a.h包含b.h， b.h包含c.h， c.h包含a.h之类导致任何一个头文件修改，都导致所有包含了a.h/b.h/c.h的代码全部重新编译一遍。而如果是单向依赖，如a.h包含b.h， b.h包含c.h，而c.h不包含任何头文件，则修改a.h不会导致包含了b.h/c.h的源代码重新编译。

规则1.3：.c/.h文件禁止包含用不到的头文件。

说明：很多系统中头文件包含关系复杂，开发人员为了省事起见，可能不会去一一钻研，直接包含一切想到的头文件，甚至有些产品干脆发布了一个god.h，其中包含了所有头文件，然后发布给各个项目组使用，这种只图一时省事的做法，导致整个系统的编译时间进一步恶化，并对后来人的维护造成了巨大的麻烦。

规则1.4：头文件应当自包含。

说明：简单的说，自包含就是任意一个头文件均可独立编译。如果一个头文件包含某个头文件，还要包含另外一个头文件才能工作的话，就会增加交流障碍，给这个头文件的用户增添不必要的负担[a2] 。

示例：

如果a.h不是自包含的，需要包含b.h才能编译，会带来的危害：每个使用a.h头文件的.c文件，为了让引入的a.h的内容编译通过，都要包含额外的头文件b.h。额外的头文件b.h必须在a.h之前进行包含，这在包含顺序上产生了依赖。

注意：该规则需要与“ .c/.h文件禁止包含用不到的头文件”规则一起使用，不能为了让a.h自包含，而在a.h中包含不必要的头文件。 a.h要刚刚可以自包含，不能在a.h中多包含任何满足自包含之外的其他头文件。

规则1.5：总是编写内部#include保护符（ #define 保护）。

说明：多次包含一个头文件可以通过认真的设计来避免。如果不能做到这一点，就需要采取阻止头文件内容被包含多于一次的机制。

通常的手段是为每个文件配置一个宏，当头文件第一次被包含时就定义这个宏，并在头文件被再次包含时使用它以排除文件内容。

所有头文件都应当使用#define 防止头文件被多重包含，命名格式为FILENAME_H，为了保证唯一性，更好的命名是PROJECTNAME_PATH_FILENAME_H。

注：没有在宏最前面加上““，即使用FILENAME_H代替FILENAME_H，是因为一般以”“和”“开头的标识符为系统保留或者标准库使用，在有些静态检查工具中，若全局可见的标识符以”_”开头会给出告警。

定义包含保护符时，应该遵守如下规则：

1）保护符使用唯一名称；

2）不要在受保护部分的前后放置代码或者注释。

示例：假定VOS工程的timer模块的timer.h，其目录为VOS/include/timer/timer.h,应按如下方式保护：

#ifndef VOS_INCLUDE_TIMER_TIMER_H #define VOS_INCLUDE_TIMER_TIMER_H ... #endif

也可以使用如下简单方式保护:

#ifndef TIMER_H #define TIMER_H .. #endif

规则1.6：禁止在头文件中定义变量。

说明：在头文件中定义变量，将会由于头文件被其他.c文件包含而导致变量重复定义。

规则1.7：只能通过包含头文件的方式使用其他.c提供的接口，禁止在.c中通过extern的方式使用外部函数接口、变量[a3] 。

说明：若a.c使用了b.c定义的foo()函数，则应当在b.h中声明extern int foo(int input)；并在a.c中通过#include 来使用foo。禁止通过在a.c中直接写extern int foo(int input);来使用foo，后面这种写法容易在foo改变时可能导致声明和定义不一致[a4] 。

规则1.8：禁止在extern “C”中包含头文件。

说明：在extern “C”中包含头文件，会导致extern “C”嵌套， Visual Studio对extern “C”嵌套层次有限制，嵌套层次太多会编译错误。

在extern “C”中包含头文件，可能会导致被包含头文件的原有意图遭到破坏。例如，存在a.h和b.h两个头文件：

使用C++预处理器展开b.h，将会得到

extern "C" { void foo(int); void b(); }

按照a.h作者的本意，函数foo是一个C++自由函数，其链接规范为”C++”。但在b.h中，由于#include “a.h”被放到了extern “C” { }的内部，函数foo的链接规范被不正确地更改了。

示例：错误的使用方式：

extern "C" { #include "xxx.h" ... }

正确的使用方式：

#include "xxx.h" extern "C" { ... }

建议1.1：一个模块通常包含多个.c文件，建议放在同一个目录下，目录名即为模块名。为方便外部使用者，建议每一个模块提供一个.h，文件名为目录名。

说明：需要注意的是，这个.h并不是简单的包含所有内部的.h，它是为了模块使用者的方便，对外整体提供的模块接口。

以Google test（简称GTest）为例， GTest作为一个整体对外提供C++单元测试框架，其1.5版本的gtest工程下有6个源文件和12个头文件。但是它对外只提供一个gtest.h，只要包含gtest.h即可使用GTest提供的所有对外提供的功能，使用者不必关系GTest内部各个文件的关系，即使以后GTest的内部实现改变了，比如把一个源文件c拆成两个源文件，使用者也不必关心，甚至如果对外功能不变，连重新编译都不需要。

对于有些模块，其内部功能相对松散，可能并不一定需要提供这个.h，而是直接提供各个子模块或者.c的头文件。

比如产品普遍使用的VOS，作为一个大模块，其内部有很多子模块，他们之间的关系相对比较松散，就不适合提供一个vos.h。而VOS的子模块，如Memory（仅作举例说明，与实际情况可能有所出入），其内部实现高度内聚，虽然其内部实现可能有多个.c和.h，但是对外只需要提供一个Memory.h声明接口。

建议1.2：如果一个模块包含多个子模块，则建议每一个子模块提供一个对外的.h，文件名为子模块名。

说明：降低接口使用者的编写难度。

建议1.3：头文件不要使用非习惯用法的扩展名，如.inc。

说明：目前很多产品中使用了.inc作为头文件扩展名，这不符合c语言的习惯用法。在使用.inc作为头文件扩展名的产品，习惯上用于标识此头文件为私有头文件。但是从产品的实际代码来看，这一条并没有被遵守，一个.inc文件被多个.c包含比比皆是。本规范不提倡将私有定义单独放在头文件中，具体见规则1.1。

除此之外，使用.inc还导致source insight、 Visual stduio等IDE工具无法识别其为头文件，导致很多功能不可用，如“跳转到变量定义处”。虽然可以通过配置，强迫IDE识别.inc为头文件，但是有些软件无法配置，如Visual Assist只能识别.h而无法通过配置识别.inc。

建议1.4：同一产品统一包含头文件排列方式。

说明：常见的包含头文件排列方式：功能块排序、文件名升序、稳定度排序。

以稳定度排序，建议将不稳定的头文件放在前面，如把产品的头文件放在平台的头文件前面，如下：

相对来说， product.h修改的较为频繁，如果有错误,不必编译platform.h就可以发现product.h的错误，可以部分减少编译时间。

[a1]例如一些屏驱动的地址文件,一些协议的格式定义文件.只存在.c或者.h即可,不一定两者都要有.

[a2]我对自包含没有太理解，只是明白在.h文件里尽量不包含没有必要的头文件,某些情况下不得已才进行包含其它头文件的操作.

[a3]这种做法我写代码常用,但后面应该尽量避免,而是通过调用头文件的方式来使用该函数.

[a4]对，我就遇到过。因为随着工程量的增大，后面某个细节调整了foo函数,但其它extern调用它的地方没有及时改正,而KEIL编译器又没有报错,导致bug出现,而且不易查找.

往期好文：

C语言、嵌入式重点知识：回调函数

C语言中的goto语句该不该使用？

什么是不完全类型？

我整理了一个嵌入式资料库，大家有什么好资料分享？可以给我留言，我把它加进去，资源共享，一起来完善这个资料库！

（资料库链接：https://gitee.com/zhengnianli/EmbedSummary）

c语言中包含头文件的预处理命令(c语言自己编写头文件)

前言

背景

依赖