Recherche sur l'ordre d'inclusion des fichiers d'en-tête C

1. Points de vue dans le « Guide de style de programmation Google C »

L'entreprise promeut les normes de codage et le leader a proposé d'utiliser essentiellement le « Guide de style de programmation Google C ». Parmi eux, le "Google C Programming Style Guide" inclut l'ordre des fichiers d'en-tête comme suit :

Names and Order of Includes
link ▽Use standard order for readability and to avoid hidden dependencies:C library, C++ library, other libraries’ .h, your project’s .h.
All of a project’s header files should belisted as descendants of the project’s source directory without use of UNIXdirectory shortcuts . 
(the current directory) or .. (the parent directory). Forexample, google-awesome-project/src/base/logging.h should be included as
#include “base/logging.h”
In dir/foo.cc or dir/foo_test.cc, whosemain purpose is to implement or test the stuff in dir2/foo2.h, order yourincludes as follows:
dir2/foo2.h (preferred location — seedetails below).
C system files.
C++ system files.
Other libraries’ .h files.
Your project’s .h files.
The preferred ordering reduces hiddendependencies. We want every header file to be compilable on its own. 
Theeasiest way to achieve this is to make sure that every one of them is the first.h file #included in some .cc.
dir/foo.cc and dir2/foo2.h are often in thesame directory (e.g. base/basictypes_test.cc and base/basictypes.h), but can bein different directories too.
Within each section it is nice to order theincludes alphabetically.
For example, the includes ingoogle-awesome-project/src/foo/internal/fooserver.cc might look like this:
#include "foo/public/fooserver.h"  // Preferred location.
#include <sys/types.h>
#include <unistd.h>
#include <hash_map>
#include <vector>
#include "base/basictypes.h"
#include"base/commandlineflags.h"
#include "foo/public/bar.h"

Ici, je vais parler de ma compréhension de ce qui précède (si c'est inapproprié, veuillez me corriger) :

1 Afin d'améliorer la lisibilité et d'éviter les dépendances implicites, l'ordre suivant doit être utilisé : bibliothèque standard C, bibliothèque standard C. , autres Les fichiers d'en-tête de la bibliothèque et les fichiers d'en-tête de votre propre projet. Cependant, le fichier d'en-tête préféré est inclus en premier, c'est-à-dire que, par exemple, un fichier.cpp doit inclure a.h en premier. Préférez les fichiers d’en-tête pour réduire les dépendances cachées tout en garantissant que les fichiers d’en-tête et les fichiers d’implémentation correspondent. Un exemple spécifique est : si vous avez un fichier cc (le suffixe du fichier cpp sur la plate-forme Linux est cc) qui est google-awesome-project/src/foo/internal/fooserver.cc, alors l'ordre des fichiers d'en-tête il contient comme suit :

#include <sys/types.h>  
#include <unistd.h>  
  
#include <hash_map>  
#include <vector>  
  
#include "base/basictypes.h"  
#include "base/commandlineflags.h"  
#include "foo/public/bar.h"

2. Lorsque vous incluez le fichier d'en-tête, vous devez ajouter le nom du dossier du projet où se trouve le fichier d'en-tête, c'est-à-dire , si vous avez une telle base de projet, il y a un logging.h dedans, alors l'inclusion externe de ce fichier d'en-tête doit être écrite comme ceci :

#include "base/logging.h" au lieu de. #include "logging.h"

Ce que nous voyons ici est "Google". Le but caché derrière les principes préconisés par le C Programming Style Guide est :

1. Afin de réduire les dépendances cachées et de faire correspondre le fichier d'en-tête avec son fichier d'implémentation, ses options d'en-tête doivent être incluses en premier (c'est-à-dire leurs fichiers d'en-tête correspondants).

2. En plus des préférences, le principe du général au particulier est suivi. Cependant, je pense que l'ordre du "Google C Programming Style Guide" : bibliothèque standard C, bibliothèque standard C, fichiers d'en-tête d'autres bibliothèques et fichiers d'en-tête de votre propre projet manque le premier élément : les fichiers d'en-tête au niveau du système d'exploitation, tels que L'exemple ci-dessus, sys/types.h, ne peut probablement pas être classé dans la bibliothèque standard C, mais il s'agit du SDK fourni par le système d'exploitation Linux. Par conséquent, je pense qu'une déclaration plus précise devrait être : OS SDK .h, bibliothèque standard C, bibliothèque standard C, fichiers d'en-tête d'autres bibliothèques et fichiers d'en-tête de votre propre projet.

3. La raison pour laquelle le répertoire du projet où se trouve le fichier d'en-tête est répertorié car les espaces de noms doivent être les mêmes, afin de distinguer les noms de fichiers en double accidentellement.

2. Différentes perspectives dans C Programming Thoughts

Contrairement au Google C Programming Style Guide, C Programming Thoughts préconise un ensemble de règles différent. "Réflexions sur la programmation C" P432 mentionné :

L'ordre dans lequel les fichiers d'en-tête sont inclus va du "le plus spécifique au plus général". Autrement dit, tous les fichiers d'en-tête du répertoire local sont inclus en premier. Viennent ensuite tous nos propres en-têtes "outils", suivis des en-têtes de bibliothèques tierces, suivis des en-têtes de bibliothèque C standard et des en-têtes de bibliothèque C.

Pour comprendre la raison : vous pouvez lire un passage de John Lakos dans « Large Scale C Softwre Design » (Remarque : sa traduction chinoise est « Large Scale C Programming ») :

Garantie. h Les composants du fichier ne sont pas analysés par eux-mêmes, ce qui évite de potentielles erreurs d'utilisation. Parce qu'être analysé par lui-même ne dispose pas d'une déclaration ou d'une définition explicitement fournie. L'inclusion du fichier .h dans la première ligne du fichier .c garantit que tous les blocs d'informations internes importants pour l'interface physique du composant sont dans le .h (si certains blocs d'informations sont effectivement manquants, ils peuvent être compilés une fois le .c le fichier est trouvé ce problème).

Si l'ordre des fichiers d'en-tête inclus est "du plus spécifique au plus général", si notre fichier d'en-tête n'est pas analysé par lui-même. Nous le trouverons immédiatement et éviterons que des problèmes ne surviennent.

3. Mon expérience

Quel ordre d'inclusion est le meilleur ? J'ai utilisé VS 2005 pour compiler un projet de test de console TestInc, qui contient plusieurs fichiers.

Le code de MyMath.h est le suivant :

#pragma once  
double acos(double Num);
MyMath.cpp的代码如下：
double acos(double Num)  
{  
    return 1.0;  
}

Le code de TestInc.cpp est comme suit :

#include "TestInc.h"  
#include <stdio.h>  
#include <math.h>  
  
int _tmain(int argc, _TCHAR* argv[])  
{  
    double a = acos(0.5);  
    return 0;  
}

Le résultat était une erreur :

1>c:program filesmicrosoft visualstudio 8vcincludemath.h(107) : error C2732: 链接规范与“acos”的早期规范冲突
1>       c:program filesmicrosoft visual studio 8vcincludemath.h(107) : 参见“acos”的声明

Ensuite, j'ai modifié l'ordre d'inclusion du fichier d'en-tête de TestInc.cpp en :

#include <stdio.h>  
#include <math.h>  
#include "TestInc.h"

La compilation est passée. Lors du débogage et de l'exécution, l'appel de fonction principal est toujours la fonction acos de la bibliothèque standard C. Il semble que l'ordre des appels de fonction soit basé sur l'ordre d'inclusion du fichier d'en-tête, c'est-à-dire que ma fonction acos personnalisée est écrasée ( si TestInc.h contient Si la fonction est connectée, la fonction en ligne sera appelée en premier).

De cette petite expérience, je suis arrivé à la conclusion suivante : L'ordre d'inclusion des fichiers d'en-tête préconisé par "Google C Programming Style Guide" et "C Programming Thoughts" a chacun son propres avantages. "Google C Programming Style Guide" devrait être capable de réduire considérablement les dépendances cachées des fichiers d'en-tête, tandis que "C Programming Ideas" vous permettra de savoir facilement si l'interface que vous définissez est en conflit avec les bibliothèques système et les bibliothèques tierces.

4. Fonction de précompilation dans l'inclusion du fichier d'en-tête

En développant dans l'environnement Visual Studio, nous avons constaté que presque tous les fichiers cpp doivent inclure le fichier stdafx.h, et il doit être placé dans le position la plus en avant, sinon une erreur se produira. Pourquoi est-ce ?

原来Visual Studio采用一种预编译的机制。要了解预编译机制，先介绍一下预编译头。所谓的预编译头就是把一个工程中的那一部分代码，预先编译好放在一个文件里（通常是以.pch为扩展名的），这个文件就称为预编译头文件这些预先编译好的代码可以是任何的C/C++代码，甚至是inline的函数，但是必须是稳定的，在工程开发的过程中不会被经常改变。如果这些代码被修改，则需要重新编译生成预编译头文件。注意生成预编译头文件是很耗时间的。同时你得注意预编译头文件通常很大，通常有6- 7M大。注意及时清理那些没有用的预编译头文件。

也许你会问：现在的编译器都有Time stamp的功能，编译器在编译整个工程的时候，它只会编译那些经过修改的文件，而不会去编译那些从上次编译过，到现在没有被修改过的文件。那么为什么还要预编译头文件呢？答案在这里，我们知道编译器是以文件为单位编译的，一个文件经过修改后，会重新编译整个文件，当然在这个文件里包含的所有头文件中的东西（.eg Macro, Preprocessor ）都要重新处理一遍。 VC的预编译头文件保存的正是这部分信息。以避免每次都要重新处理这些头文件。

根据上文介绍，预编译头文件的作用当然就是提高便宜速度了，有了它你没有必要每次都编译那些不需要经常改变的代码。编译性能当然就提高了。

要使用预编译头，我们必须指定一个头文件，这个头文件包含我们不会经常改变的代码和其他的头文件，然后我们用这个头文件来生成一个预编译头文件（.pch 文件）想必大家都知道StdAfx.h这个文件。很多人都认为这是VC提供的一个“系统级别”的，编译器带的一个头文件。其实不是的，这个文件可以是任何名字的。我们来考察一个典型的由AppWizard生成的MFC Dialog Based　程序的预编译头文件。（因为AppWizard会为我们指定好如何使用预编译头文件，默认的是StdAfx.h，这是VC起的名字）。我们会发现这个头文件里包含了以下的头文件：

#include <afxext.h> // MFC extensions  
#include <afxdisp.h> // MFC Automation classes  
#include <afxdtctl.h> // MFC support for Internet Explorer 4 Common Controls 
#include <afxcmn.h>

这些正是使用MFC的必须包含的头文件，当然我们不太可能在我们的工程中修改这些头文件的，所以说他们是稳定的。

那么我们如何指定它来生成预编译头文件。我们知道一个头文件是不能编译的。所以我们还需要一个cpp文件来生成.pch 文件。这个文件默认的就是StdAfx.cpp。在这个文件里只有一句代码就是：#include“Stdafx.h”。原因是理所当然的，我们仅仅是要它能够编译而已―――也就是说，要的只是它的.cpp的扩展名。我们可以用/Yc编译开关来指定StdAfx.cpp来生成一个.pch文件，通过/Fp 编译开关来指定生成的pch文件的名字。打开project ->Setting->C/C++ 对话框。把Category指向Precompiled Header。在左边的树形视图里选择整个工程，Project Options(右下角的那个白的地方)可以看到 /Fp “debug/PCH.pch”，这就是指定生成的.pch文件的名字，默认的通常是　.pch。然后，在左边的树形视图里选择 StdAfx.cpp，这时原来的Project Option变成了 Source File Option（原来是工程，现在是一个文件，当然变了）。在这里我们可以看到 /Yc开关，/Yc的作用就是指定这个文件来创建一个Pch文件。/Yc后面的文件名是那个包含了稳定代码的头文件，一个工程里只能有一个文件的可以有 YC开关。VC就根据这个选项把 StdAfx.cpp编译成一个Obj文件和一个PCH文件。

这样，我们就设置好了预编译头文件。也就是说，我们可以使用预编译头功能了。以下是注意事项：

1）如果使用了/Yu，就是说使用了预编译，我们在每个.cpp文件的最开头，包含你指定产生pch文件的.h文件（默认是stdafx.h）不然就会有问题。如果你没有包含这个文件，就告诉你Unexpected file end.

2）如果你把pch文件不小心丢了，根据以上的分析，你只要让编译器生成一个pch文件就可以了。也就是说把stdafx.cpp（即指定/Yc的那个cpp文件）重新编译一遍就可以了。

那么在Linux平台下有没有这种预编译机制呢？如果有，它是怎么实现的呢？Linux平台下GCC编译器也实现了预编译机制的。这里以开源IDE CodeBlocks（CodeBlocks内置了GCC编译器）的工程为例来说明Linux平台的实现：

使用CodeBlocks建一个C++工程，然后新建一个my_pch.h，输入如下代码：

/*************************************************************** 
 * Name:      my_pch.h 
 * Purpose:   Header to create Pre-Compiled Header (PCH) 
 * Author:     () 
 * Created:   2010-10-26 
 * Copyright:  () 
 * License: 
 * 使用方法: 项目构建选项-->其他选项-->填入下面两行 
 -Winvalid-pch 
 -include my_pch.h 
 **************************************************************/  
  
#ifndef MY_PCH_H_INCLUDED  
#define MY_PCH_H_INCLUDED  
  
// put here all your rarely-changing header files  
  
#include <iostream>  
#include <string>  
  
#endif

然后在项目构建选项–>其他选项–>填入下面两行

-Winvalid-pch
-include my_pch.h

就可以启用预编译文件头。

然后 main.cpp 就可以不用 include 头文件了，直接这样就可以编译了

int main()  
{   
using namespace std;  
    cout << "Hello world!" << endl;  
    return 0;  
}

即使在上面的代码写上下面一行，其实是不起作用的：

#include <iostream>

以上就是C++ 头文件的包含顺序研究的内容，更多相关内容请关注PHP中文网（www.php.cn）！