c++头文件写作需要注意一点规则

• 通常，在一个 C++ 程序中，只包含两类文件—— .cpp 文件和 .h 文件。其中，.cpp 文件被称作 C++ 源文件；而 .h 文件则被称作 C++ 头文件。C++ 语言支持"分别编译"（separatecompilation）。也就是说，一个程序所有的内容，可以分成不同的部分分别放在不同的 .cpp 文件里。.cpp 文件里的东西都是相对独立的，在编译（compile）时不需要与其他文件互通，只需要在编译成目标文件后再与其他的目标文件做一次链接（link）就行了。

  • 比如，在文件 a.cpp 中定义了一个全局函数 “void a(){}”，而在文件 b.cpp 中需要调用这个函数。即使这样，文件 a.cpp 和文件 b.cpp 并不需要相互知道对方的存在，而是可以分别地对它们进行编译，编译成目标文件之后再链接，整个程序就可以运行了。

  • 这是怎么实现的呢？从写程序的角度来讲，很简单。在文件 b.cpp 中，在调用 “void a()” 函数之前，先声明一下这个函数 “void a();”，就可以了。这是因为编译器在编译 b.cpp 的时候会生成一个符号表（symbol table），像 “void a()” 这样的看不到定义的符号，就会被存放在这个表中。再进行链接的时候，编译器就会在别的目标文件中去寻找这个符号的定义。一旦找到了，程序也就可以顺利地生成了。

  • 注意这里提到了两个概念，一个是"定义"，一个是"声明"。简单地说，"定义"就是把一个符号完完整整地描述出来：它是变量还是函数，返回什么类型，需要什么参数等等。而"声明"则只是声明这个符号的存在，即告诉编译器，这个符号是在其他文件中定义的，我这里先用着，你链接的时候再到别的地方去找找看它到底是什么吧。定义的时候要按 C++ 语法完整地定义一个符号（变量或者函数），而声明的时候就只需要写出这个符号的原型了。需要注意的是，$一个符号，在整个程序中可以被声明多次，但却要且仅要被定义一次$。

  • 这种机制给 C++ 程序员们带来了很多好处，同时也引出了一种编写程序的方法。考虑一下，如果有一个很常用的函数 “void f() {}”，在整个程序中的许多 .cpp 文件中都会被调用，那么，我们就只需要在一个文件中定义这个函数，而在其他的文件中声明这个函数就可以了。一个函数还好对付，声明起来也就一句话。但是，如果函数多了，比如是一大堆的数学函数，有好几百个，那怎么办？能保证每个程序员都可以完完全全地把所有函数的形式都准确地记下来并写出来吗？

  • 很显然，答案是不可能。但是有一个很简单地办法，可以帮助程序员们省去记住那么多函数原型的麻烦：我们可以把那几百个函数的声明语句全都先写好，放在一个文件里，等到程序员需要它们的时候，就把这些东西全部 copy 进他的源代码中。

  • 这个方法固然可行，但还是太麻烦，而且还显得很笨拙。于是，头文件便可以发挥它的作用了。所谓的头文件，其实它的内容跟 .cpp 文件中的内容是一样的，都是 C++ 的源代码。但头文件不用被编译。我们把所有的函数声明全部放进一个头文件中，当某一个 .cpp 源文件需要它们时，它们就可以通过一个宏命令 “#include” 包含进这个 .cpp 文件中，从而把它们的内容合并到 .cpp 文件中去。当 .cpp 文件被编译时，这些被包含进去的 .h 文件的作用便发挥了。

• 举一个例子吧，假设所有的数学函数只有两个：f1 和 f2，那么我们把它们的定义放在 math.cpp 里：

  • /* math.cpp */
    double f1()
    {
        //do something here....
        return;
    }
    double f2(double a)
    {
        //do something here...
        return a * a;
    }
    /* end of math.cpp */
    

  • 并把"这些"函数的声明放在一个头文件 math.h 中：

  • /* math.h */
    double f1();
    double f2(double);
    /* end of math.h */
    

  • 在另一个文件main.cpp中，我要调用这两个函数，那么就只需要把头文件包含进来：

  • /* main.cpp */
    #include "math.h"
    main()
    {
        int number1 = f1();
        int number2 = f2(number1);
    }
    /* end of main.cpp */
    

  • 这样，便是一个完整的程序了。需要注意的是，.h 文件不用写在编译器的命令之后，但它必须要在编译器找得到的地方（比如跟 main.cpp 在一个目录下）main.cpp 和 math.cpp 都可以$分别通过编译$，生成 main.o 和 math.o，然后再把这两个目标文件进行链接，程序就可以运行了。

• #include 是一个来自 C 语言的宏命令，它在编译器进行编译之前，即在预编译的时候就会起作用。#include 的作用是把它后面所写的那个文件的内容，完完整整地、一字不改地包含到当前的文件中来。值得一提的是，它本身是没有其它任何作用与副功能的，它的作用就是把每一个它出现的地方，替换成它后面所写的那个文件的内容。简单的文本替换，别无其他。因此，main.cpp 文件中的第一句（#include"math.h"），在编译之前就会被替换成 math.h 文件的内容。即在编译过程将要开始的时候，main.cpp 的内容已经发生了改变：

  • /* ~main.cpp */
    double f1();
    double f2(double);
    main()
    {
        int number1 = f1();
        int number2 = f2(number1);
    }
    /* end of ~main.cpp */
    

  • 不多不少，刚刚好。同理可知，如果我们除了 main.cpp 以外，还有其他的很多 .cpp 文件也用到了 f1 和 f2 函数的话，那么它们也通通只需要在使用这两个函数前写上一句 #include “math.h” 就行了。

• 通过上面的讨论，可以了解到，头文件的作用就是被其他的 .cpp 包含进去的。它们本身并不参与编译，但实际上，它们的内容却在多个 .cpp 文件中得到了编译。通过"定义只能有一次"的规则，我们很容易可以得出，头文件中应该只放变量和函数的声明，而不能放它们的定义。因为一个头文件的内容实际上是会被引入到多个不同的 .cpp 文件中的，并且它们都会被编译。放声明当然没事，如果放了定义，那么也就相当于在多个文件中出现了对于一个符号（变量或函数）的定义，纵然这些定义都是相同的，但对于编译器来说，这样做不合法。

• 所以，应该记住的一点就是，.h头文件中，只能存在变量或者函数的声明，而不要放定义。即，只能在头文件中写形如：extern int a; 和 void f(); 的句子，这些才是声明。如果写上 int a;或者 void f() {} 这样的句子，那么一旦这个头文件被两个或两个以上的 .cpp 文件包含的话，编译器会立马报错。但是，这个规则是有三个例外的:

  • 一，头文件中可以写 const 对象的定义。因为全局的 const 对象默认是没有 extern 的声明的，所以它只在当前文件中有效。把这样的对象写进头文件中，即使它被包含到其他多个 .cpp 文件中，这个对象也都只在包含它的那个文件中有效，对其他文件来说是不可见的，所以便不会导致多重定义。同时，因为这些 .cpp 文件中的该对象都是从一个头文件中包含进去的，这样也就保证了这些 .cpp 文件中的这个 const 对象的值是相同的，可谓一举两得。同理，static 对象的定义也可以放进头文件。
  • 二，头文件中可以写内联函数（inline）的定义。因为inline函数是需要编译器在遇到它的地方根据它的定义把它内联展开的，而并非是普通函数那样可以先声明再链接的（内联函数不会链接），所以编译器就需要在编译时看到内联函数的完整定义才行。如果内联函数像普通函数一样只能定义一次的话，这事儿就难办了。因为在一个文件中还好，我可以把内联函数的定义写在最开始，这样可以保证后面使用的时候都可以见到定义；但是，如果我在其他的文件中还使用到了这个函数那怎么办呢？这几乎没什么太好的解决办法，因此 C++ 规定，内联函数可以在程序中定义多次，只要内联函数在一个 .cpp 文件中只出现一次，并且在所有的 .cpp 文件中，这个内联函数的定义是一样的，就能通过编译。那么显然，把内联函数的定义放进一个头文件中是非常明智的做法。
  • 三，头文件中可以写类（class）的定义。因为在程序中创建一个类的对象时，编译器只有在这个类的定义完全可见的情况下，才能知道这个类的对象应该如何布局，所以，关于类的定义的要求，跟内联函数是基本一样的。所以把类的定义放进头文件，在使用到这个类的 .cpp 文件中去包含这个头文件，是一个很好的做法。在这里，值得一提的是，类的定义中包含着数据成员和函数成员。数据成员是要等到具体的对象被创建时才会被定义（分配空间），但函数成员却是需要在一开始就被定义的，这也就是我们通常所说的类的实现。一般，我们的做法是，把类的定义放在头文件中，而把函数成员的实现代码放在一个 .cpp 文件中。这是可以的，也是很好的办法。不过，还有另一种办法。那就是直接把函数成员的实现代码也写进类定义里面。在 C++ 的类中，如果函数成员在类的定义体中被定义，那么编译器会视这个函数为内联的。因此，把函数成员的定义写进类定义体，一起放进头文件中，是合法的。注意一下，如果把函数成员的定义写在类定义的头文件中，而没有写进类定义中，这是不合法的，因为这个函数成员此时就不是内联的了。一旦头文件被两个或两个以上的 .cpp 文件包含，这个函数成员就被重定义了。

• 考虑一下，如果头文件中只包含声明语句的话，它被同一个 .cpp 文件包含再多次都没问题——因为声明语句的出现是不受限制的。然而，上面讨论到的头文件中的三个例外也是头文件很常用的一个用处。那么，一旦一个头文件中出现了上面三个例外中的任何一个，它再被一个 .cpp 包含多次的话，问题就大了。因为这三个例外中的语法元素虽然"可以定义在多个源文件中"，但是"在一个源文件中只能出现一次"。设想一下，如果 a.h 中含有类 A 的定义，b.h 中含有类 B 的定义，由于类B的定义依赖了类 A，所以 b.h 中也 #include了a.h。现在有一个源文件，它同时用到了类A和类B，于是程序员在这个源文件中既把 a.h 包含进来了，也把 b.h 包含进来了。这时，问题就来了：类A的定义在这个源文件中出现了两次！于是整个程序就不能通过编译了。你也许会认为这是程序员的失误——他应该知道 b.h 包含了 a.h ——但事实上他不应该知道。

  • 使用 “#define” 配合条件编译可以很好地解决这个问题。在一个头文件中，通过 #define 定义一个名字，并且通过条件编译 #ifndef…#endif 使得编译器可以根据这个名字是否被定义，再决定要不要继续编译该头文中后续的内容。这个方法虽然简单，但是写头文件时一定记得写进去。

• 源文件如何根据 #include 来关联头文件

  • 系统自带的头文件用尖括号括起来，这样编译器会在系统文件目录下查找。
  • 用户自定义的文件用双引号括起来，编译器首先会在用户目录下查找，然后在到 C++ 安装目录（比如 VC 中可以指定和修改库文件查找路径，Unix 和 Linux 中可以通过环境变量来设定）中查找，最后在系统文件中查找。

• 头文件如何来关联源文件

  • 这个问题实际上是说，已知头文件 “a.h” 声明了一系列函数，“b.cpp” 中实现了这些函数，那么如果我想在 “c.cpp” 中使用 “a.h” 中声明的这些在 "b.cpp"中实现的函数，通常都是在 “c.cpp” 中使用 #include “a.h”，那么 c.cpp 是怎样找到 b.cpp 中的实现呢？其实 .cpp 和 .h 文件名称没有任何直接关系，很多编译器都可以接受其他扩展名。比如有的源代码，.cpp 文件由 .cc 文件替代了。
  • 在 Turbo C 中，采用命令行方式进行编译，命令行参数为文件的名称，默认的是 .cpp 和 .h，但是也可以自定义为 .xxx 等等。谭浩强老师的《C 程序设计》一书中提到，编译器预处理时，要对 #include 命令进行"文件包含处理"：将 file2.c 的全部内容复制到 #include “file2.c” 处。这也正说明了，为什么很多编译器并不 care 到底这个文件的后缀名是什么----因为 #include 预处理就是完成了一个"复制并插入代码"的工作。
  • 编译的时候，并不会去找 b.cpp 文件中的函数实现，只有在 link 的时候才进行这个工作。我们在 b.cpp 或 c.cpp 中用 #include “a.h” 实际上是引入相关声明，使得编译可以通过，程序并不关心实现是在哪里，是怎么实现的。源文件编译后成生了目标文件（.o 或 .obj 文件），目标文件中，这些函数和变量就视作一个个符号。在 link 的时候，需要在 makefile 里面说明需要连接哪个 .o 或 .obj 文件（在这里是 b.cpp 生成的 .o 或 .obj 文件），此时，连接器会去这个 .o 或 .obj 文件中找在 b.cpp 中实现的函数，再把他们 build 到 makefile 中指定的那个可以执行文件中。
  • 在 Unix下，甚至可以不在源文件中包括头文件，只需要在 makefile 中指名即可（不过这样大大降低了程序可读性，是个不好的习惯哦^_）。在 VC 中，一帮情况下不需要自己写 makefile，只需要将需要的文件都包括在 project中，VC 会自动帮你把 makefile 写好。
  • 通常，C++ 编译器会在每个 .o 或 .obj 文件中都去找一下所需要的符号，而不是只在某个文件中找或者说找到一个就不找了。因此，如果在几个不同文件中实现了同一个函数，或者定义了同一个全局变量，链接的时候就会提示 “redefined”。

• .h文件中能包含：

  • 类成员数据的声明，但不能赋值
  • 类静态数据成员的定义和赋值，但不建议，只是个声明就好。
  • 类的成员函数的声明
  • 非类成员函数的声明
  • 常数的定义：如：const int a=5;
  • 静态函数的定义，但是不能包含，static 成员函数和成员变量的定义。
  • 类的内联函数的定义

• 不能包含：

  • 所有非静态变量（不是类的数据成员）的声明
  • 默认命名空间声明不要放在头文件，using namespace std;等应放在.cpp中，在 .h 文件中使用 std::string

• 一般而言，每个C++/C程序通常由头文件和定义文件组成。头文件作为一种包含功能函数、数据接口声明的载体文件，主要用于保存程序的声明，而定义文件用于保存程序的实现(就是所谓.c/.cpp)。C++/C程序的头文件以“.h”为后缀。以下是假设名称为graphics.h的头文件：

  • #ifndef GRAPHICS_H//作用：防止graphics.h被重复引用
    #define GRAPHICS_H
    #include<....>//引用标准库的头文件
    ...
    #include"..."//引用非标准库的头文件
    ...
    void Function1(...);//全局函数声明
    ...
    inline();//inline函数的定义
    ...
    classBox//作用：类结构声明
    {
    ...
    };
    #endif
    

  • 从以上例子可以看出，头文件一般由四部分内容组成：

    • (1)头文件开头处的版权和版本声明；[不要也无所谓]
    • (2)预处理块；
    • (3)inline函数的定义；
    • (4)函数和类结构声明等。

• 什么样的内容适合放在头文件里？用户构造的数据类型（如枚举类型），外部变量，外部函数、常量和内联函数等，具有一定通用性或常用的量。而一般性的变量和函数定义不宜放在头文件中。

• 传统 C++标准头文件

  • #include<algorithm>//STL通用算法
    #include<bitset>//STL位集容器
    #include<bits/stdc++.h>//编译器GCC 4.8支持的万能头文件，基本包含所有头文件
    #include<cctype>//C字符处理
    #include<cerrno>//C的错误报告机制
    #include<clocale>
    #include<cmath>//兼容C语言数学库
    #include<complex>//复数类
    #include<cstdio>//C语言输入输出工具
    #include<cstdlib>//C语言通用工具
    #include<cstring>//C字符串
    #include<ctime>
    #include<deque>//STL双端队列容器
    #include<exception>//异常处理类
    #include<fstream>//文件输入输出流
    #include<functional>//STL定义运算函数（代替运算符）
    #include<limits>
    #include<list>//STL线性列表容器
    #include<map>//STL映射容器
    #include<iomanip>
    #include<ios>//基本输入/输出支持
    #include<iosfwd>//输入/输出系统使用的前置声明
    #include<iostream>//基本输入输出流
    #include<queue>//STL队列容器
    #include<set>//STL集合容器
    #include<sstream>//基于字符串的流
    #include<stack>//STL堆栈容器
    #include<stdexcept>//标准异常类
    #include<streambuf>//底层输入/输出支持
    #include<string>//字符串类
    #include<utility>//STL通用模板类
    #include<vector>//STL动态数组容器
    #include<cwchar>
    #include<cwctype>
    //在C++中，标准库的命名空间为std，因而包含了上述头文件时，一般会使用下列语句： 
    using namespace std;
    //C99 版本
    #include<complex.h>//复数处理
    #include<fenv.h>//浮点环境
    #include<inttypes.h>//整数格式转换
    #include<stdbool.h>//布尔环境
    #include<stdint.h>//整型环境
    #include<tgmath.h>//通用类型数学宏