mermaid-diagrams

# Mermaid 图表绘制 使用 Mermaid 的文本语法创建专业软件图表。Mermaid 从简单的文本定义渲染图表，使图表可版本控制、易于更新，并能与代码同步维护。 ## 核心语法结构 所有 Mermaid 图表都遵循此模式： mermaid diagramType definition content **关键原则：** - 第一行声明图表类型（例如 `classDiagram`, `sequenceDiagram`, `flowchart`） - 使用 `%%` 进行注释 - 换行和缩进可提高可读性，但非必须 - 未知单词会导致图表中断；参数错误会静默失败 ## 图表类型选择指南 **选择正确的图表类型：** 1. **类图** - 领域建模、OOP 设计、实体关系 - 领域驱动设计文档 - 面向对象类结构 - 实体关系和依赖 2. **序列图** - 时间交互、消息流 - API 请求/响应流程 - 用户身份验证流程 - 系统组件交互 - 方法调用序列 3. **流程图** - 流程、算法、决策树 - 用户旅程和工作流 - 业务流程 - 算法逻辑 - 部署流水线 4. **实体关系图 (ERD)** - 数据库模式 - 表关系 - 数据建模 - 模式设计 5. **C4 图** - 多层级软件架构 - 系统上下文（系统和用户） - 容器（应用程序、数据库、服务） - 组件（内部结构） - 代码（类/接口级别） 6. **状态图** - 状态机、生命周期状态 7. **Git 图** - 版本控制分支策略 8. **甘特图** - 项目时间线、进度安排 9. **饼图/柱状图** - 数据可视化 ## 快速入门示例 ### 类图 (领域模型) mermaid classDiagram Title -- Genre Title *-- Season Title *-- Review User --> Review : creates class Title { +string name +int releaseYear +play() } class Genre { +string name +getTopTitles() } ### 序列图 (API 流程) mermaid sequenceDiagram participant User participant API participant Database User->>API: POST /login API->>Database: Query credentials Database-->>API: Return user data alt Valid credentials API-->>User: 200 OK + JWT token else Invalid credentials API-->>User: 401 Unautho