如何在Doxygen继承图中排除调试用C++模板类？

我之前处理过几乎一模一样的场景——调试用的私有继承类把Doxygen继承图搞得一团糟，完全没必要让它出现在公开文档里。这里有几个实用的办法解决这个问题：

方法1：用@cond/@endcond精准隐藏调试代码块 #

Doxygen支持用条件标签来忽略特定内容，你可以把调试类的定义和所有继承它的代码段包在@cond和@endcond里，只让Doxygen在调试模式外忽略这些内容：

// 仅在DEBUG模式下编译的调试类
#ifdef DEBUG
@cond DEBUG_DEBUG_HELPER
class DebugHelper {
    // 调试相关的实现代码
};
@endcond
#endif

// 业务类的定义
class MyServiceClass {
#ifdef DEBUG
@cond DEBUG_DEBUG_HELPER
private:
    // 私有继承调试类
    : private DebugHelper
@endcond
#endif
    // 业务类的核心功能代码
    void doWork();
};

这个方法的好处是精准控制，只会隐藏调试相关的继承逻辑，不会影响业务类的其他文档内容。需要注意标签要配对使用，避免不小心把正常代码也排除了。

方法2：用@internal标记+配置文件过滤 #

如果这个调试类完全属于内部实现细节，你可以给它加上@internal标签，然后修改Doxygen配置文件让内部文档不被生成：

首先在代码里标记调试类：

/**
 * @internal
 * 仅用于调试的辅助类，不属于项目公开API范畴
 */
class DebugHelper {
    // 调试实现
};

然后打开你的Doxyfile配置文件，找到INTERNAL_DOCS选项，把它设置为：

INTERNAL_DOCS = NO

这样Doxygen会自动忽略所有标记了@internal的内容，包括它的继承关系，直接从继承图里移除这个节点。

方法3：用宏封装继承逻辑（适合编译期控制的场景） #

如果你的调试继承是通过宏来开关的，可以直接让Doxygen在非调试模式下看不到继承语句：

#ifdef DEBUG
#define DEBUG_BASE_CLASS private DebugHelper
#else
#define DEBUG_BASE_CLASS  // 空定义
#endif

// 业务类继承
class OrderProcessor : DEBUG_BASE_CLASS {
    // 业务代码
};

这种方式下，当DEBUG未定义时，Doxygen解析到的继承列表里不会有DebugHelper，自然不会出现在继承图中。如果调试模式下也不想显示，再结合前面的@cond标签即可。

内容的提问来源于stack exchange，提问作者Jeremy Friesner