C/C++ 头文件（.h 文件）中使用 #include 指令

1、尽量避免在头文件中使用 #include

为了减少头文件之间的相互依赖（循环依赖），从而提高代码的可维护性和可移植性。如果多个头文件包含了相同的头文件，编译器可能会进行多次解析，浪费时间和资源。多个头文件相互包含时，可能导致编译器无法处理头文件之间的依赖关系。多个头文件相互包含时，可能导致编译器无法处理头文件之间的依赖关系。

1）a.h

// a.h
#ifndef A_H
#define A_H

// 前向声明，避免直接包含其他头文件
struct B;  // 假设B是一个结构体类型

void functionA(struct B *b);

#endif  // A_H

2）b.h

// b.h
#ifndef B_H
#define B_H

// 直接包含a.h会造成循环依赖，所以在这里仅进行前向声明
struct A;

struct B {
    struct A *a_instance;
    int b_value;
};

#endif  // B_H

3）源文件中包含头文件并定义实现

// a.c
#include "a.h"
#include "b.h"  // 需要在源文件中包含b.h

void functionA(struct B *b) {
    // 使用B结构体的代码
    b->b_value = 100;
}

// b.c
#include "b.h"
#include "a.h"  // 需要在源文件中包含a.h

void functionB(struct A *a) {
    // 使用A结构体的代码
    a->a_value = 10;
}

2、使用前向声明

使用前向声明可以有效地减少对头文件的依赖，前向声明可以告诉编译器某个类型或结构体的存在，而无需完全包含其定义。如需要在使用指向某个类型指针的地方，使用前向声明而不是直接 #include 该类型的头文件。避免直接在头文件中包含完整的类型定义。

#include <stdio.h>

// 前向声明结构体
struct MyStruct;  

// 函数声明，接受指向结构体的指针
void function(struct MyStruct *ptr);

// 定义结构体
struct MyStruct {
    int x;
    int y;
};

// 函数实现
void function(struct MyStruct *ptr) {
    if (ptr != NULL) {
        printf("x = %d, y = %d\n", ptr->x, ptr->y);
    }
}

int main() {
    // 创建结构体实例
    struct MyStruct obj = {5, 10};

    // 传递结构体指针给函数
    function(&obj);

    return 0;
}

3、使用包含保护

如果必须在头文件中包含其他头文件，确保使用 包含保护 来防止同一个头文件被重复包含。#ifndef, #define, 和 #endif 语句通常用来确保头文件只被编译一次。

#ifndef MY_HEADER_H
#define MY_HEADER_H

// 头文件内容
void helloWorld();

#endif // MY_HEADER_H

4、尽量将实现放入 .cpp 文件

如在头文件中包含了一个实现（例如某个类的方法的定义），这会导致编译时所有包含该头文件的源文件都被重新编译。因此，将类的实现放入.cpp 文件中而不是头文件中，这样只需要在源文件中包含一次头文件即可。