如何通过Doxygen按软件架构层级组织文件树状视图？

可以通过Doxygen的模块分组层级化结合配置调整，实现匹配软件架构的树状视图，既不会合并页面，也无需手动维护静态目录，具体步骤如下：

1. 用@defgroup和@ingroup构建层级分组 #

放弃单纯使用@addtogroup，改用嵌套组定义逻辑：

• 顶层模块（如application、ecu_abstraction）用@defgroup定义为一级组，对应架构最上层
• 子模块（如app1、component1）用@ingroup关联到父组，同时用@defgroup定义自身为独立组

示例配置 #

在application.md中：

@defgroup application 应用层
@brief 负责业务逻辑实现的顶层模块

在app1.md中：

@defgroup app1 应用1
@ingroup application
@brief 具体业务应用1的实现

同理，ecu_abstraction.md定义顶层组，component1.md用@ingroup ecu_abstraction关联父组。

2. 调整Doxygen配置文件（Doxyfile） #

修改以下关键配置项，确保层级结构被正确渲染：

• 设置GROUP_NESTED = YES：允许组嵌套，开启层级树状显示
• 设置GENERATE_TREEVIEW = YES：启用HTML侧边栏的树状视图
• 可选设置SHOW_INCLUDE_FILES = NO：若只需保留模块层级，可隐藏头文件/源文件的扁平化显示
• 可选设置MAX_INITIALIZER_LINES = 0：避免代码初始化内容干扰分组结构

3. 关联代码文件到对应组 #

在每个.c/.h文件的头部，用@ingroup将代码归属到对应子组，确保代码文档纳入架构层级：
比如app1.c开头：

/**
 * @ingroup app1
 * @file app1.c
 * @brief app1的核心实现代码
 */

4. 验证效果 #

生成文档后，HTML侧边栏的树状视图会自动匹配项目架构：

• application
  • app1
  • app2
• ecu_abstraction
  • component1
  • component2

每个组都是独立页面，不会被合并；后续新增模块只需添加对应组关联即可，无需手动维护目录结构。

内容的提问来源于stack exchange，提问作者Ricard Molins