39bd06adea
- 新增 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 目录结构加入说明
1.4 KiB
1.4 KiB
tools/arch_diagram/ — 架构图 SVG 生成器
用 Python 脚本精确生成架构类 SVG 图(分层、内存布局、协议帧、屏障等), 产物放
docs/images/。用于"必须精确布局"的图;拓扑图(流程/时序/状态机)改用 Mermaid。
脚本一览
| 脚本 | 产物 | 用途 |
|---|---|---|
gen_arch_svg.py |
架构分层图 | 六层分层结构 |
gen_memory_svg.py |
内存布局图 | RAM / Flash 分区 |
gen_storage_stack_svg.py |
存储栈图 | FTL / dhara / FatFs 三层栈 |
gen_net_stack_svg.py |
网络栈图 | BSD 网络栈分层 |
gen_barrier_svg.py |
就绪屏障图 | Event Flags 屏障模型 |
gen_frame_svg.py |
协议帧格式图 | RemoDispBus 帧结构 |
gen_cfg_arch_svg.py |
配置引擎架构图 | 配置分层与持久化 |
gen_partition_svg.py |
分区图 | 存储分区 |
使用方式
& '.venv\Scripts\python.exe' tools/arch_diagram/gen_memory_svg.py
产物统一输出到 docs/images/;脚本与生成的 .svg 一并提交。
⚠️ 约定
- 颜色/字体遵循
docs/架构设计/图形绘制流程.md的规范 - 中文用 SVG
<text>直接写(需注意字体族声明) - 改图改脚本再重跑,不手改 SVG(保证可复现)
相关文档
docs/架构设计/图形绘制流程.md— 配图规范、选型与检查清单