Files
STM32F4-Base/tools/refgraph
wandering1 39bd06adea 为自建代码目录补齐 README,建立目录级导航体系
- 新增 26 份目录 README:App/(+log,task,util,protocol)、Drivers/BSP/(+8子系统)、
  Src/、Inc/、scripts/、tools/(+6子工具)、test/、MDK-ARM/、simulator/(+sim,tests)
- 每份含:定位、文件清单表、关键约束/陷阱、指向 docs 权威文档
- 第三方库与生成代码目录排除(CMSIS/HAL/Middlewares/Lib/SDL2)
- docs/文档规范.md 新增 §1.1b 代码目录 README 约定;根 README 目录结构加入说明
2026-09-26 12:25:36 +08:00
..

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