class-diagram

根据代码生成Mermaid类图,可视化类型、继承与组合关系

安装使用

复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:

帮我安装这个 AI Skill:class-diagram。
它的用途是:根据代码生成Mermaid类图,可视化类型、继承与组合关系
完整的 Skill 内容见:https://321skill.com/skills/class-diagram-x-6/raw/index.md
请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。

提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。

使用示例

'请为下面这段TypeScript代码生成Mermaid类图。' 然后粘贴你的接口和类定义代码。AI会调用该Skill,分析代码中的`interface`、`class`、`extends`和`implements`等关键字,生成包含类名、属性和关系连线的Mermaid文本。你可以直接使用这段文本在文档中嵌入可交互的类图。

介绍

这个Skill能自动分析代码中的类、接口、枚举等类型定义,并生成对应的Mermaid类图。它解决了开发者在理解复杂代码结构、进行架构设计评审或编写技术文档时,手动绘制和维护类图耗时费力且易出错的问题。

使用时,只需向AI提供你的代码片段或描述需要分析的代码结构,AI便会调用该Skill生成标准的Mermaid语法文本。你可以将此文本直接粘贴到支持Mermaid的Markdown编辑器或图表工具中,即可渲染出清晰的类图。

它非常适合需要快速梳理项目结构、为新成员讲解代码库、或在设计文档中嵌入架构图的全栈开发、后端开发和文档工程师。对于处理遗留代码或进行代码重构的项目,此工具能极大提升效率。

建议在使用时,尽量提供清晰、完整的类型定义代码,以确保生成的图表准确反映所有继承、实现和组合关系。对于非常庞大或分散的代码库,可以分模块进行分析,再组合成完整视图。

核心特点

专注于从代码文本直接生成Mermaid类图,无需依赖项目编译或复杂的静态分析工具链,简化了获取架构视图的流程。

注意事项

不适合分析运行时动态生成或通过反射定义的类结构,也无法处理代码逻辑中隐含的、非明确定义的类型关系。

常见问题

支持哪些编程语言?

主要面向具有明确类/类型定义的语言,如TypeScript、Java、C#等,通过解析代码文本中的关键字和结构来工作。

生成的图表能导出吗?

生成的是标准Mermaid语法文本,可复制到任何支持Mermaid的平台(如GitHub Markdown、Obsidian、Mermaid Live Editor)渲染为图片或SVG。

给 AI 助手的安装指引

如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:

请访问 https://321skill.com/skills/class-diagram-x-6/raw/index.md 读取 class-diagram 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。