【问题标题】:Where to put my standard library headers when creating classes in C++?在 C++ 中创建类时,我的标准库头文件应该放在哪里?
【发布时间】:2019-03-12 09:37:54
【问题描述】:

如果我错了,请纠正我,C++ 标头开头的#ifndef 内容特别有助于避免代码重复?

那么(根据最佳实践)我应该将基本库头文件(如 或 )放在哪里?

让我用一个例子来澄清这个问题

假设我有一个程序可以创建 Employee 类并存储有关它们的信息..比如他们的名字或其他东西

  1. 我有一个 int main(),它使用 std::cout ALOT 向控制台显示信息。它甚至可以使用硬编码字符串变量将信息存储到其中一个类中(我知道硬编码不好,请耐心等待,这将有助于我澄清事情)

  2. 我有一个名为 Employee.h 的头文件,其中包含我所有的私有变量。在这种情况下,是员工的姓名。它还有函数声明。让我们假设它在其中一个构造函数中使用字符串数据类型。

  3. 一个 Employee.cpp 进行设置和获取...很酷让我们也假设它有一些奇怪的函数来操纵员工姓名(这是一个字符串)并在它前面添加“yolo”。凉爽的。所以这个文件也需要访问 库

到目前为止:我的三个文件都想使用 标头,只有 main.cpp 想使用 标头。

我的问题:

似乎 标头可以放在 Eployee 标头而不是 main.cpp 中,程序将编译并运行得很好...但是如果我将它放在 main 而不是 Employee 标头中,编译器疯狂。那么我应该将它包含在 main 和 header 中还是仅包含在 header 中?

如果我创建第二个名为 Companies 的类也使用字符串库,这种最佳实践会改变吗?

附:有人可以解释一下常见的预处理器是如何链接东西的……比如为什么当只包含在主文件中而不是标题中时计算机会抛出错误……我认为这些东西都是链接在一起的……我很笨,请解释一下

(我想我理解所有关于 obj 文件的胡言乱语,但是预处理器和编译器如何知道头代码在类 .cpp 和主 .cpp 中都没有重复?

感谢您的耐心阅读,我也感谢您以这种方式为像我这样的 c++ 菜鸟提供的任何帮助。

【问题讨论】:

  • 标准库头文件使用预处理器指令保护自己。您可以在编译单元中多次包含它们。限制是在您打开任何命名空间之前必须包含它们。所以是的,如果你的头文件需要库头中可用的定义,它应该包含它 - 在它自己的包含保护中。
  • 因此,由于任何库头都包含在类头中,而 main.cpp 包含类头...是否还需要在主文件中包含库头?
  • "如果您使用它,请包含它。"是我一直听到的建议。在您的 main.cpp 中,如果您需要 iostream 工具,我会 #include <iostream> 即使另一个头文件也包含它。否则,如果您出于任何原因将 main.cpp 更改为 不 使用该头文件,突然 main.cpp 将无法编译。

标签: c++ class header preprocessor


【解决方案1】:

根据 C++ 标准:

翻译单元是 C++ 中编译的基本单元。它 由单个源文件的内容以及 它直接或间接包含的任何头文件,减去那些 使用条件预处理语句忽略的行。

注意,“间接包含”的措辞。另一个标头中#include 的任何标头都包含在#includes 该标头的任何源文件中。因此,如果您要求将其包含在标头中,也就是说,如果您的标头需要 定义 而不仅仅是 声明,#include 就在那里。

如何生成翻译单元的一个小例子:最初我们有我们的标题。我们称之为stdfoo.h(这是一个例子,你应该避免用std命名你自己的标题以避免冲突。)

#ifndef STD_FOO_ // here is our header guard
#define STD_FOO_

typedef long howl_t;
void foo();

#endif // STD_FOO_ close the header guard at the end

让我们把它包含在我们的项目源代码main.cxx:

#include <stdfoo.h>

int main {
    foo();
    return 0;
};

当我们编译它时,它会通过预处理器运行到翻译单元中。让我们看看生成的单元可能是什么样子:

typedef long howl_t;
void foo();

int main {
    foo();
    return 0;
};

#include 指令在翻译单元中扩展了stdfoo.h,因此编译器可以查看单个翻译单元并生成一个对象。

让我们改变一下,给main.cxx一个标题,main.h。

#ifndef MAIN_H
#define MAIN_H

class BarkBark {
    BarkBark() {}
    void emit();
};

#endif // MAIN_H

在我们的新 main.cxx 中使用它:

#include "main.h"
#include <stdfoo.h>

int main {
    BarkBark woof;
    woof.emit();
    foo();
    return 0;
};

翻译单元如下所示:

class BarkBark {
    BarkBark() {}
    void emit();
};

typedef long howl_t;
void foo();

int main {
    BarkBark woof;
    woof.emit();
    foo();
    return 0;
};

现在说emit 使用howl_t 作为参数,就像void emit(howl_t h) 这将需要重新声明howl_t,这是一种冒险的方式,或者在main.h 中包含stdfoo.h

#ifndef MAIN_H
#define MAIN_H

#include <stdfoo.h>

class BarkBark {
    BarkBark() {}
    void emit(howl_t h);
};

#endif // MAIN_H

那个翻译单元看起来怎么样?

typedef long howl_t;
void foo();

class BarkBark {
    BarkBark() {}
    void emit();
};

int main {
    howl_t aroooooo = 0;
    BarkBark woof;
    woof.emit(aroooooo);
    return 0;
};

预处理器扩展了 #include 内部的 #included 标头。

注意#include &lt;stdfoo.h&gt; 是否保留在main.cxx 中,由于预处理器处理标头保护,翻译单元看起来相同,第二个包含被简单地丢弃。

现在,就标准库头文件而言,并非所有标准库中的大多数都可以防止多重包含,因此您可以随时#include 随心所欲地频繁使用,而不会产生不良影响。生成的翻译单元将只包含一次以进行编译。请注意,任何其他标头都不能保证这一点,并且多次包含不受保护的标头会产生非常模糊的错误,因为重复的声明仅存在于翻译单元中。

所以要回答您的问题,如果您的标头需要包含特定的类或函数,请在标头中 #include 它。此时,您是否决定在源文件中也使用#include 它是一种风格选择。有人说如果标题发生变化,有人说不要简化代码。这个选择真的取决于你。

如果另一个头文件中不需要一个头文件,最好只将它包含在每个需要它的源文件中,这样您的代码就可以生成更小的翻译单元来编译并减少命名空间污染。

但是!这不是一个硬性规定。有些人的做法不同,并将#includes 安排到可以使用它们的逻辑位置或在多个源文件中使用某些标头以减少代码重复的位置。就我个人而言,我认为这种安排会增加技术债务,如果代码可以被改进或重构并且标题成为孤立的。

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2017-11-06
    • 1970-01-01
    • 1970-01-01
    • 2014-02-17
    • 1970-01-01
    • 1970-01-01
    • 2010-12-01
    • 2018-09-28
    相关资源
    最近更新 更多