misc-header-include-cycle

检查检测用户定义头文件之间的循环 #include 依赖关系。

// Header A.hpp
#pragma once
#include "B.hpp"

// Header B.hpp
#pragma once
#include "C.hpp"

// Header C.hpp
#pragma once
#include "A.hpp"

// Include chain: A->B->C->A

头文件是许多 C++ 程序的重要组成部分，它们提供了一种组织在多个源文件中共享的声明和定义的方法。但是，头文件在陷入复杂的依赖循环时也会造成问题。这种循环会导致编译时间问题、不必要的重建，以及更难以理解代码的整体结构。

为了解决这些问题，已经开发了一个检查来检测头文件之间的循环依赖关系，也称为“包含循环”。包含循环发生在当一个头文件 A 包含头文件 B 时，而 B（或任何后续包含的头文件）包含回头文件 A，导致循环依赖循环。

此检查在预处理器级别运行，专门分析用户定义的头文件及其依赖关系。它只专注于检测包含循环，而不考虑其他类型或函数依赖关系。这种专门的分析有助于识别和防止与头文件组织相关的問題。

通过在开发过程的早期检测包含循环，开发人员可以在这些问题变得更难更耗时地修复之前识别和解决这些问题。这可以导致更快的编译时间、提高代码质量以及更易于维护的代码库。此外，通过确保头文件以避免循环依赖的方式组织，开发人员可以随着时间的推移使他们的代码更易于理解和修改。

值得注意的是，只分析用户定义的头文件及其依赖关系，系统包含（如标准库头文件和第三方库头文件）被排除在外。系统包含通常设计良好且没有包含循环，忽略它们有助于专注于项目自身代码库中的潜在问题。此限制不会降低在分析的代码中检测 #include 循环的能力。

开发人员应仔细查看此解决方案提供的任何警告或反馈。虽然分析旨在识别和防止包含循环，但可能存在需要例外或修改的情况。在进行调整时，重要的是要谨慎判断并考虑代码库的特定上下文。

选项

IgnoredFilesList

提供了一种方法来将特定文件/头文件从检查引发的警告中排除。这可以通过指定分号分隔的正则表达式或文件名列表来实现。此选项可以用作 //NOLINT 的替代方案，当使用它不可行时。此选项的默认值为一个空字符串，表示默认情况下不忽略任何文件。