如何实现标头防护，以及在它们之间可以放置什么？

发布于 2024-10-13 08:02:14 字数 697 浏览 9 评论 0原文

在 LearnCpp.com | 1.10 — 初步了解预处理器。在头保护下，有这些代码片段：

add.h:

#include "mymath.h"
int add(int x, int y);

subtract.h:

#include "mymath.h"
int subtract(int x, int y);

main.cpp：

#include "add.h"
#include "subtract.h"

在实现头保护时，提到如下：

#ifndef ADD_H
#define ADD_H

// your declarations here

#endif

什么可以声明在这里吗？而且，int main() 应该在#endif 之后吗？
添加 _H 是约定还是必须做的事情？

原文

At LearnCpp.com | 1.10 — A first look at the preprocessor. Under Header guards, there are those code snippets:

add.h:

#include "mymath.h"
int add(int x, int y);

subtract.h:

#include "mymath.h"
int subtract(int x, int y);

main.cpp:

#include "add.h"
#include "subtract.h"

In implementing the header guard, it is mentioned as follows:

#ifndef ADD_H
#define ADD_H

// your declarations here

#endif

What could the declaration be here? And, should int main() come after #endif?
Is adding _H a convention or a must do thing?

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

甜柠檬 2024-10-20 08:02:15

FILENAME_H 是一种约定。如果你真的想要，你可以使用#ifndef FLUFFY_KITTENS作为标头保护（假设它没有在其他地方定义），但如果你在其他地方定义它，比如数字，那将是一个棘手的错误的小猫的某事或其他。

在头文件 add.h 中，声明实际上位于 #ifndef 和 #endif 之间。

#ifndef ADD_H
#define ADD_H

#include "mymath.h"
int add(int x, int y);

#endif

最后，int main() 不应该出现在头文件中。它应该始终位于 .cpp 文件中。

澄清一下：

#ifndef ADD_H 基本上意味着“如果 ADD_H 尚未在文件或包含的文件中#define，则编译 # 之间的代码ifndef 和 #endif 指令”。因此，如果您尝试在 .cpp 文件中多次#include "add.h"，编译器将看到 ADD_H 已经#define< /code> 并将忽略 #ifndef 和 #endif 之间的代码。标头防护仅防止标头文件多次包含在同一个 .cpp 文件中。标头防护不会阻止其他 .cpp 文件包含该标头文件。但所有 .cpp 文件都可以仅包含一次受保护的头文件。

The FILENAME_H is a convention. If you really wanted, you could use #ifndef FLUFFY_KITTENS as a header guard (provided it was not defined anywhere else), but that would be a tricky bug if you defined it somewhere else, say as the number of kittens for something or other.

In the header file add.h the declarations are literally between #ifndef and #endif.

#ifndef ADD_H
#define ADD_H

#include "mymath.h"
int add(int x, int y);

#endif

Finally, int main() shouldn't be in a header file. It should always be in a .cpp file.

To clear it up:

#ifndef ADD_H basically means "if ADD_H has not been #defined in the file or in an included file, then compile the code between #ifndef and #endif directives". So if you try to #include "add.h" more than once in a .cpp file, the compiler will see what the ADD_H was already #defined and will ignore the code between #ifndef and #endif. Header guards only prevent a header file from being included multiple times in the same .cpp file. Header guards don't prevent other .cpp files from including the header file. But all .cpp files can include the guarded header file only once.

回复收藏 0 原文

时光沙漏 2024-10-20 08:02:15

预处理一个实现（“.cpp”）文件的结果是一个翻译单元（TU）。
标头可以包含其他标头，因此标头可以在同一 TU 内间接包含多次。（您的 mymath.h 就是一个例子。）
每个 TU 定义最多只能出现一次。（某些定义也不得出现在多个 TU 中；这种情况略有不同，此处不予讨论。）
包含防护解决的问题是在给定标头在一个 TU 中多次包含时防止出现多个定义错误。
包含防护通过“包装”标头的内容来工作，这样第二个和后续包含都是无操作的。 #ifndef/#define 指令应该是文件的前两行，#endif 应该是最后一行。
包含防护仅在标头中使用。不要在标头中定义主函数：将其放入实现文件中。

如果您有一个将定义类型并声明函数的标头，但还需要标头本身：

#include "other_header.h"

struct Example {};

void f();

使用包含防护“包装”它会给出文件的完整内容：

#ifndef UNIQUE_NAME_HERE
#define UNIQUE_NAME_HERE

#include "other_header.h"

struct Example {};

void f();

#endif

用于包含防护的名称必须是唯一的，否则会发生冲突名称会产生令人困惑的结果。这些名称只是简单的宏，语言中没有任何内容强制执行某种风格。然而，项目惯例通常会提出要求。您可以在 SO 和其他地方找到几种不同的包含防护命名样式；这个答案提供了很好的标准和很好的概述。

The result of preprocessing one implementation (".cpp") file is a translation unit (TU).
Headers can include other headers, so a header may be indirectly included multiple times within the same TU. (Your mymath.h is an example of this.)
Definitions can only occur at most once per TU. (Some definitions must also not be in multiple TUs; this case is slightly different and not discussed here.)
The problem include guards solve is preventing multiple definition errors when a given header is included more than once within one TU.
Include guards work by "wrapping" the contents of the header in such a way that the second and subsequent includes are no-ops. The #ifndef/#define directives should be the first two lines of the file, and #endif should be the last.
Include guards are only used in headers. Do not define your main function in a header: put it in an implementation file.

If you have a header that will define a type and declare a function, but also needs a header itself:

#include "other_header.h"

struct Example {};

void f();

"Wrapping" it with include guards gives the complete contents of the file:

#ifndef UNIQUE_NAME_HERE
#define UNIQUE_NAME_HERE

#include "other_header.h"

struct Example {};

void f();

#endif

The name used for the include guard must be unique, otherwise conflicting names will give confusing results. These names are only simple macros, and there is nothing in the language which enforces a certain style. However, project conventions usually impose requirements. There are several different include guard naming styles you can find here on SO and elsewhere; this answer gives good criteria and a good overview.

回复收藏 0 原文