代码转 Mermaid 图表
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_82af032c/code2diagram。
技能介绍
适合什么问题
当一段代码的控制流、状态迁移、接口调用或实体关系散落在多个文件里,工程师往往要手工梳理调用顺序、状态分支和数据结构。code2diagram 面向这个场景:它读取指定目录或文件,识别代码中的主要逻辑模式,并把结果落成可直接评审的图表资料,而不是只给出口头说明。
技能如何工作
核心输出是两份文件:
- Markdown 文档:包含 Mermaid 源码,可在支持 Mermaid 的编辑器或 GitHub 中预览。
- PNG 图片:高清渲染结果,适合贴入文档、评论或截图。
执行过程大致分四步:先用 Read、Glob、Grep 理解代码结构,再根据模式选择图表类型,例如状态机用 stateDiagram-v2,接口消息用 sequenceDiagram,实体关系用 erDiagram。随后生成 Mermaid 源码并写入 .mmd 文件,再调用渲染脚本生成图片。
使用边界
图表文字会倾向使用中文,但类名、函数名、变量名等专有标识符保留原文。依赖 Node.js 和 npx,脚本会尝试调用 mermaid-cli;复杂工程仍需人工确认抽象层级,不能把所有细节都机械映射成一张图。
使用场景
- 接手陌生仓库后,先梳理主流程与状态分支,为评审准备可读图。
- 把接口调用链和消息顺序整理成时序图,方便排查跨服务调用问题。
- 将领域实体和字段关系画成实体图,用于文档补充和新人讲解。
- 为工作流引擎代码生成状态图,确认状态迁移与边界条件。
适合人员
- 负责后端服务重构、需要把调用链讲清楚的工程师
- 接手遗留代码、准备技术评审图的工程师
- 编写架构文档、需要插图说明数据流的工程师
- 维护工作流系统、需要梳理状态机的工程师