Files
STM32F4-Base/tools/refgraph

tools/refgraph/ — 文件引用关系图

扫描全仓库 .c/.h 的 #include 关系,生成文件级 + 模块级引用关系图(Graphviz)。

文件一览

文件 作用
gen_refgraph.bat 一键入口(调用 gen_refgraph.py + Graphviz 渲染)
gen_refgraph.py 扫描 #include → 生成 .dot → 渲染 .svg / .json

使用方式

& 'tools\refgraph\gen_refgraph.bat'

产物(放 docs/images/)

产物 内容
引用关系图.dot Graphviz 源
引用关系图.svg / .png 渲染图(.svg 提交,.png 本地预览不提交)
引用关系图.json 结构化引用数据

⚠️ 注意

  • 项目文件变化后重跑更新(新增/删除源文件、改 include 关系)
  • 渲染依赖 Graphviz(winget install graphviz 可装)
  • 脚本与 .dot/.svg/.json 一并提交

相关文档

  • docs/架构设计/引用关系图说明.md
  • docs/架构设计/项目架构总览.md