包含在 header 文件中

Question

header 文件應該有#include嗎？

我通常認為這種分層包含是不好的。 假設你有這個：

富.h：

#include <stdio.h> // we use something from this library here
struct foo { ... } foo;

main.c

#include "foo.h"
/* use foo for something */
printf(...)

當 main.c 的實現發生變化，你不再使用 foo.h 時，編譯會中斷，你必須手動添加<stdio.h> 。

與擁有這個相比：

foo.h

// Warning! we depend on stdio.h
struct foo {...

main.c

#include <stdio.h> //required for foo.h, also for other stuff
#include "foo.h"

當你停止使用 foo 時，刪除它不會破壞任何東西，但是刪除 stdio.h 會破壞 foo.h。

應該從.h 文件中禁止#includes 嗎？

Answer 1

你已經概述了關於這個主題的兩種主要哲學。

我自己的觀點（我認為這就是人們真正可以擁有的全部）是標題應該盡可能獨立。 我不想為了能夠使用 header 而知道foo.h的所有依賴項。 我也鄙視必須以特定順序包含標題。

然而， foo.h的開發者也應該負責使其盡可能地無依賴。 例如，如果可能的話，應該將foo.h header 編寫為不依賴於stdio.h （使用前向聲明可以幫助實現這一點）。

請注意，C 標准禁止一個標准 header 包含另一個標准 header，但 ZF6F097C9FDCF1F883 標准沒有2C 因此，當從一個 C++ 編譯器版本遷移到另一個編譯器版本時，您可以看到您描述的問題。 例如，在 MSVC 中，包括用於引入<iterator>的<vector> ，但在 MSVC 2010 中不再出現，因此之前編譯的代碼可能不再存在，因為您可能需要專門包含<iterator> 。

然而，盡管 C 標准似乎提倡第二種理念，但請注意，它還要求沒有 header 依賴於另一個標准，並且您可以以任何順序包含標題。 因此，您可以兩全其美，但代價是 C 庫的實現者的復雜性。 他們必須跳過一些障礙才能做到這一點（特別是為了支持可以通過多個標頭中的任何一個引入的定義，例如NULL或size_t ）。 我猜想起草 C++ 標准的人決定增加模仿者的復雜性不再合理（我不知道 C++ 庫實現者在多大程度上利用了“漏洞” - 看起來 MS 可能正在收緊這一點，即使它在技術上不是必需的）。

Answer 2

我的一般建議是：

• 文件應該#include它需要的內容。
• 它不應該期望其他東西來#include它需要的東西。
• 它不應該#include不需要的東西，因為其他東西可能需要它。

真正的測試是這樣的：您應該能夠編譯包含任何單個#include的源文件，並且除了“沒有main() ”之外不會出現錯誤或警告。 如果你通過了這個測試，那么你可以期待任何其他東西都能夠#include你的文件而沒有問題。 我編寫了一個名為“hcheck”的簡短腳本，我用它來測試它：

#!/usr/bin/env bash
# hcheck: Check header file syntax (works on source files, too...)
if [ $# -eq 0 ]; then
    echo "Usage: $0 <filename>"
    exit 1
fi

for f in "$@" ; do
    case $f in
        *.c | *.cpp | *.cc | *.h | *.hh | *.hpp )
            echo "#include \"$f\"" > hcheck.cc
            printf "\n\033[4mChecking $f\033[0m\n"
            make -s $hcheck.o
            rm -f hcheck.o hcheck.cc
            ;;
    esac
done

我確信這個腳本有幾件事可以做得更好，但這應該是一個很好的起點。

如果這太多了，並且如果您的 header 文件幾乎總是有相應的源文件，那么另一種技術是要求關聯的 header 是源文件中的第一個#include 。 例如：

富.h：

#ifndef Foo_h
#define Foo_h

/* #includes that Foo.h needs go here. */

/* Other header declarations here */

#endif

Foo.c：

#include "Foo.h"
/* other #includes that Foo.c needs go here. */

/* source code here */

這也顯示了其他人提到的 Foo.h 中的“包含守衛”。

通過將#include "Foo.h"放在首位， Foo.h必須#include其依賴項，否則會出現編譯錯誤。

Answer 3

好吧， main 不應該首先依賴於stdio的"foo.h" 。 包含兩次並沒有什么壞處。
另外，也許 foo。 h並不真正需要stdio 。 更有可能的是foo.c （實現）需要stdio 。

長話短說，我認為每個人都應該只包括他們需要的任何東西，並依靠包括警衛。

Answer 4

一旦您進入具有數百或數千個 header 文件的項目，這將變得站不住腳。 假設我有一個名為"MyCoolFunction.h"的 header 文件，其中包含MyCoolFunction()的原型，並且 function 將指向結構的指針作為參數。 我應該能夠假設包含MyCoolFunction.h將包含所有必要的內容，並允許我使用 function 而無需查看 .h 文件以查看我需要包含的其他內容。

Answer 5

如果 header 文件需要特定的 header，請將其添加到 header 文件中

#ifndef HEADER_GUARD_YOUR_STYLE
#define HEADER_GUARD_YOUR_STYLE

#include <stdio.h> /* FILE */
int foo(FILE *);

#endif /* HEADER GUARD */

如果代碼文件不需要 header，則不要添加

/* #include <stdio.h> */ /* removed because unneeded */
#include <stddef.h> /* NULL */
#include "header.h"
int main(void) {
  foo(NULL);
  return 0;
}

Answer 6

為什么不在與 header 對應的 *.c 文件中#include 東西？