class-diagram
一键生成Mermaid类图,展示类型继承与组合
安装使用
复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:
帮我安装这个 AI Skill:class-diagram。 它的用途是:一键生成Mermaid类图,展示类型继承与组合 完整的 Skill 内容见:https://321skill.com/skills/class-diagram-x-5/raw/index.md 请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
'请根据以下TypeScript代码生成Mermaid类图:class User { id: number; name: string; } class Admin extends User { role: string; } class Order { user: User; items: Product[]; } class Product { id: number; price: number; }',它会返回对应的Mermaid代码,展示User与Admin的继承关系、Order与User的组合关系、Order与Product的聚合关系。
介绍
在开发过程中,理解代码的类型结构、继承关系和组合关系往往需要花费大量时间阅读源码或手动绘制UML图。class-diagram 技能能够根据你提供的代码或描述,自动生成符合Mermaid语法的类图,帮助你快速可视化类、接口、抽象类之间的继承、实现、聚合、组合等关系,从而提升代码理解和文档编写效率。
使用方式非常简单:你只需描述需要分析的代码结构(例如粘贴一段代码片段,或说明项目中的类名和关系),技能便会输出对应的Mermaid类图代码。你可以直接复制该代码到支持Mermaid渲染的平台(如Markdown编辑器、Notion、GitHub等)中查看可视化结果。整个过程无需手动绘制,也无需记忆复杂的Mermaid语法。
该技能特别适合后端开发、全栈开发以及文档工程师。后端开发可以在重构或代码审查时快速生成当前模块的类图,验证设计模式的合理性;全栈开发可以在跨项目协作时用类图统一团队对类型结构的理解;文档工程师则可以将类图嵌入技术文档,降低读者理解门槛。
建议在生成类图后,结合项目实际代码对输出的关系进行二次确认,确保继承和组合的箭头方向正确。若代码中存在大量循环依赖或动态类型,该技能可能无法完整覆盖所有细节,需要手动补充或调整。另外,Mermaid类图对复杂关系的渲染能力有限,建议保持每个类图涉及的类型数量在15个以内以获得最佳可读性。
核心特点
与通用代码分析工具不同,class-diagram 专注于类型层面的可视化,直接输出Mermaid代码而非图片,可在任何支持Mermaid的平台上编辑和复用,且无需安装额外渲染引擎。
注意事项
不适合处理动态类型语言(如Python中的鸭子类型)或存在大量循环依赖的复杂系统,且无法自动从整个项目目录中提取关系,需手动提供代码上下文。
常见问题
能生成哪些类型的类图?
支持展示类、接口、抽象类之间的继承、实现、聚合、组合、依赖关系,以及类中的属性和方法。
支持哪些编程语言?
理论上支持任何面向对象语言,但需要你提供代码片段或明确描述类型关系;对Java、C#、TypeScript等静态类型语言效果最佳。
给 AI 助手的安装指引
如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:
请访问 https://321skill.com/skills/class-diagram-x-5/raw/index.md 读取 class-diagram 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址:/skills/class-diagram-x-5/raw/index.md(查看排版版本)