关于Doxygen自动列出函数调用变量及生成变量调用关系图的问询

针对你想要在变量文档里显示调用它的函数、生成变量与函数关系图的需求，结合Doxygen 1.8.14的特性，给你整理了具体实现方法：

1. 在变量_test_var的说明中自动列出调用它的函数 #

Doxygen默认不会自动生成变量的调用函数列表，但可以通过自定义反向引用来实现，步骤很清晰：

• 首先，在每个调用_test_var的函数注释里，添加关联标记：

  /**
   * 设置测试变量的值
   * \xrefitem uses_var "使用的变量" "函数使用的变量列表" 调用了变量 _test_var
   */
  void set_test(int val) {
      _test_var = val;
  }
  
  /**
   * 获取测试变量的值
   * \xrefitem uses_var "使用的变量" "函数使用的变量列表" 调用了变量 _test_var
   */
  int get_test() {
      return _test_var;
  }
  

• 然后，在_test_var的注释里，添加反向引用命令，Doxygen会自动收集所有标记过的函数并生成列表：

  /**
   * 测试变量
   * \xrefitem used_by "调用此变量的函数" "调用变量的函数列表"
   */
  int _test_var;
  

  生成的文档里，_test_var的说明部分会自动出现一个列表，包含set_test和get_test这两个函数。

2. 生成变量与调用函数的关系图 #

要生成可视化的关系图，需要先在你的Doxygen配置文件（Doxyfile）里开启Graphviz支持：

• 确保HAVE_DOT = YES
• 如果Graphviz没在系统默认路径，设置DOT_PATH = /你的graphviz安装路径/bin
• 可选：设置DOT_GRAPH_MAX_NODES = 50（按需调整）避免图过于复杂

有两种方式生成关系图：

• 组关系图：把_test_var和调用它的函数归到同一个组，开启GROUP_GRAPHS = YES，这样组内的关系图会自动展示变量和函数的关联。示例：

  /**
   * \defgroup test_group 测试模块
   * @{
   */
  
  /**
   * 测试变量
   */
  int _test_var;
  
  /**
   * 设置测试变量的值
   */
  void set_test(int val) {
      _test_var = val;
  }
  
  /**
   * 获取测试变量的值
   */
  int get_test() {
      return _test_var;
  }
  /** @} */
  

• 自定义DOT图：如果需要更精准的控制，可以在变量注释里手动绘制关系图：

  /**
   * 测试变量
   * \dot
   * digraph var_callers {
   *   node [shape=box];
   *   "_test_var" -> "set_test" [label="被调用"];
   *   "_test_var" -> "get_test" [label="被调用"];
   * }
   * \enddot
   */
  int _test_var;
  

  这样生成的文档里会直接显示一个清晰的关系图，标注哪些函数调用了这个变量。

3. 在函数描述中自动列出调用的变量 #

遗憾的是，Doxygen 1.8.14没有内置功能自动提取函数内调用的变量并生成列表。不过有两种替代方案：

• 手动标记：在函数注释里直接列出调用的变量，比如：

  /**
   * 设置测试变量的值
   * 调用的变量：_test_var
   */
  void set_test(int val) {
      _test_var = val;
  }
  

• 脚本辅助：可以写个简单的Python脚本（或其他语言）分析代码，自动提取函数内的变量引用，生成Doxygen注释片段后插入到代码中。这需要额外的工具支持，但能实现半自动化。

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