推荐的 C++ 包含实践

Question

在以下场景中，包含<string> 标头的最佳方法是什么？

main.cpp

#include "extra.h"

int main() {
    func("A string");
    return 0;
}

额外的.h

#ifndef EXTRA_H
#define EXTRA_H

    #include <string>

    void func(std::string);

#endif

额外的.cpp

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

void func(std::string str) {
    std::cout << str << '\n';
}

Answer 1

您的extra.h 包含<string>，因为它直接使用它。在您的main.cpp 中没有直接使用std::string，因此在其中包含<string> 会很奇怪。

此外，在extra.cpp 中包含<string> 是完全没有必要的，因为std::string 的使用是在您知道在extra.h 中声明的函数签名中，加上两个extra 文件的维护可以合理地预计会作为单个操作完成，所以不用担心extra.h 突然不包括<string> 然后打破extra.cpp，因为它们会一起维护。

Answer 2

头文件应包含尽可能少的内容。这使它保持干净，并且还允许更快的编译。如果头文件需要完整的类型，则必须在头文件中包含该类型的包含文件，否则使用前向声明。

例如 ma​​in.h

#pragma once

// if your header uses a full type (see function h)
// it needs to know the size of the type
// then include header file for that type in your header

#include <string>
void h(std::string str);

// if your header only has references or pointers to a type
// then add a forward declaration of that type.
// The compiler only has to know the size for the reference/pointer

struct struct_t; 

void f(const struct_t& s);
void g(const struct_t* s);

然后是 ma​​in.cpp

#include "main.h"
#include <iostream>
// #include <string> not really needed already done in "main.h"

// full declaration of struct_t in the place where it is needed.
// note this could also be in done in its own header file. 
struct struct_t
{
    int value1;
    int value2;
};

void f(const struct_t& s)
{
    std::cout << s.value1 << std::endl;
    std::cout << s.value2 << std::endl;
}

void g(const struct_t* s)
{
    std::cout << s->value1 << std::endl;
    std::cout << s->value2 << std::endl;
}

void h(std::string s)
{
    std::cout << s << std::endl;
}

int main()
{
    struct_t values{ 0, 42 };
    f(values);
    g(&values);
    h("Hello World!");
}