建立和使用標頭檔案介紹

在 C 專案中建立和使用標頭檔案時,需要遵循許多準則:

  • Idemopotence

    如果在翻譯單元(TU)中多次包含標頭檔案,則不應破壞構建。

  • 自圍堵

    如果需要在標頭檔案中宣告的工具,則不必顯式包含任何其他頭。

  • 極小

    你不應該在不導致構建失敗的情況下從標頭中刪除任何資訊。

  • 包括你使用的(IWYU)

    C++比 C 更關注,但在 C 中也很重要。如果 TU 中的程式碼(稱為 code.c)直接使用標題宣告的特徵(稱之為 headerA.h),則 code.c 應該直接 #include "headerA.h",即使 TU 包含另一個標題(稱之為 headerB.h),此刻,包括 headerA.h

偶爾,可能有足夠的理由打破這些指南中的一個或多個,但是你們都應該意識到你違反了規則並且在打破它之前要意識到這樣做的後果。