C++ 入门（五）— 头文件（Header files）

头文件的用途

C++ 代码文件（扩展名为 .cpp）并不是 C++ 程序中唯一常见的文件。 另一种类型的文件称为头文件。 头文件通常使用 .h 作为 扩展名。

头文件的主要用途是将声明传播到代码 (.cpp) 文件。

头文件允许我们将声明放在一个位置，然后在需要的地方导入它们。 这可以节省多文件程序中的大量输入。

使用标准库头文件

#include <iostream>//标准库

int main()
{
    std::cout << "Hello, world!";// std::cout   使用标准库头文件
    return 0;
}

使用头文件传播前向声明

创建三个脚本：

add.h

int AddFunc(int x, int y); 

add.cpp

#include "add.h" 
int AddFunc(int x, int y)
{
    return x + y;
}

main.cpp

#include "add.h" 
#include <iostream>

int main()
{
    std::cout << "The sum of 3 and 4 is " << AddFunc(3, 4) << '\n';
    return 0;
}

当预处理器处理该行时，它会将 add.h 的内容复制到此时的当前文件中。因为我们的 add.h 包含函数 add（） 的正向声明，所以该正向声明将被复制到 main.cpp 中。
最终结果是一个程序，其功能与我们在 main.cpp 顶部手动添加转发声明的程序相同。

因此，我们的程序将正确编译和链接。
然后我们然后按上图进行编译，过程步骤：

• 编译处理：
  1. 对 add.cpp，add.h 编译处理：
     g++ -c add.cpp add.h
     编译后，会生成 add.o、add.h.gch文件：
     
     此时是乱码的，我们可以通过反编译命令查看 add.o文件信息：
     在命令行执行 objdump -h add.o
     
  2. 以同样的方式对main.cpp 编译处理：
     g++ -c main.cpp
     生成 main.o文件
  3. 链接 add.o和main.o文件
     g++ main.o add.o -o main.exe
     生成 main.exe 文件
     它也是乱码的，我们可以通过反编译命令查看 main.exe文件信息：
     在命令行执行objdump -h main.exe
  4. 最后，运行./main.exe,可以看到输出结果：
     

避免将函数或变量定义放在头文件中

这样做通常会导致违反单一定义规则 （ODR） 的情况，即头文件包含在多个源文件中。
比如，在 add.h文件中：

int AddFunc(int x, int y)
{
    return x + y;
}

尖括号与双引号

当我们使用尖括号时，我们告诉预处理器这是一个不是我们自己编写的头文件。预处理器将仅在 指定的目录中搜索标头。它们配置为项目/IDE 设置/编译器设置的一部分，通常默认为包含编译器和/或操作系统附带的头文件的目录。预处理器不会在项目的源代码目录中搜索头文件。include directoriesinclude directories

当我们使用双引号时，我们告诉预处理器这是我们编写的头文件。预处理器将首先在当前目录中搜索头文件。如果它在那里找不到匹配的标头，它将搜索 .include directories

VSCode中添加来自其他目录的头文件

对于 GCC/G++ 用户

使用 g++，可以使用 -I 选项指定备用包含目录：
g++ -o main -I/source/includes main.cpp
-I 后面没有空格。

对于 VS Code 用户

在 tasks.json 配置文件中，在“Args”部分添加一个新行：
“-I/source/includes”,

头文件保护

对于头文件，很容易出现头文件中的定义被多次包含的情况。当一个头文件 #includes 另一个头文件（这很常见）时，可能会发生这种情况。

可以通过一种称为标头保护（也称为包含保护）的机制来避免上述问题。标头防护是采用以下形式的条件编译指令：

#ifndef SOME_UNIQUE_NAME_HERE
#define SOME_UNIQUE_NAME_HERE

// your declarations (and certain types of definitions) here

#endif

#included 此标头时，预处理器会检查之前是否已定义SOME_UNIQUE_NAME_HERE。

所有头文件都应具有标头保护。SOME_UNIQUE_NAME_HERE可以是您想要的任何名称，但按照惯例，它设置为头文件的完整文件名，键入全部大写字母，使用下划线作为空格或标点符号。
例如，square.h 将具有标头保护：

#ifndef SQUARE_H
#define SQUARE_H

int getSquareSides()
{
    return 4;
}

#endif

甚至标准库标头也使用标头保护。如果要查看 Visual Studio 中的 iostream 头文件，则会看到：

#ifndef _IOSTREAM_
#define _IOSTREAM_

// content here

#endif

标头保护不会阻止标头包含在不同的代码文件中

标头保护的目标是防止代码文件接收受保护标头的多个副本。根据设计，标头保护不会阻止给定的头文件（一次）包含在单独的代码文件中。这也可能导致意外问题。

pragma once

现代编译器支持使用预处理器指令的更简单的替代形式的标头保护：

#pragma once

// your code here

#pragma once其用途与标头防护相同：避免多次包含头文件。但它不是标准化的，只是大多数开发人员使用的习惯。

总结

标头防护旨在确保给定头文件的内容不会多次复制到任何单个文件中，以防止重复定义。

重复声明是可以的，但即使头文件由所有声明（无定义）组成，最好还是包含标头保护。

请注意，标头防护不会阻止将头文件的内容（一次）复制到单独的项目文件中。这是一件好事，因为我们经常需要从不同的项目文件中引用给定标头的内容。