当前位置: 首页 > news >正文

Mermaid 语法全解析:从基础到高级可视化

Mermaid 语法全解析:从基础到高级可视化

Mermaid 是一款强大的基于文本的图表绘制工具,通过简洁的语法即可生成专业的流程图、时序图、甘特图等。本文将深入探讨 Mermaid 的各类语法及其适用场景。

一、流程图(Flowchart)

流程图是最常用的图表类型,用于展示流程、算法或工作流。

基本语法:

开始
条件判断
执行操作1
执行操作2
结束

关键要素:

  • 方向:TD(从上到下)、LR(从左到右)等
  • 节点形状:[](矩形)、()(圆角矩形)、{}(菱形)等
  • 连接线:-->(实线箭头)、-.->(虚线箭头)等
二、时序图(Sequence Diagram)

时序图用于展示对象之间的消息传递顺序。

基本语法:

用户系统数据库登录请求验证码提交验证码查询用户信息返回用户数据登录成功用户系统数据库

关键要素:

  • 参与者:participant 定义角色
  • 消息类型:->>(实线消息)、-->>(虚线消息)等
  • 激活状态:+- 表示对象的激活和失活
三、甘特图(Gantt Chart)

甘特图用于项目进度规划和跟踪。

基本语法:

2023-01-012023-04-012023-07-012023-10-012024-01-012024-04-012024-07-012024-10-012025-01-012025-04-012025-07-01需求收集 需求文档编写 架构设计 需求评审 详细设计 需求分析设计阶段项目开发计划

关键要素:

  • 标题:title 定义图表标题
  • 日期格式:dateFormat 指定日期显示格式
  • 任务:section 分组,任务定义包含ID、名称、时间范围等
四、类图(Class Diagram)

类图用于展示面向对象系统中的类、接口及其关系。

基本语法:

Animal
+string name
+int age
+eat()
+sleep()
Dog
+string breed
+bark()
Cat
+bool hasWhiskers
+meow()

关键要素:

  • 类定义:class 关键字
  • 成员:+(公有)、-(私有)、#(受保护)
  • 关系:<|--(继承)、*--(组合)等
五、状态图(State Diagram)

状态图用于描述对象在其生命周期中的各种状态及状态转换。

基本语法:

接收到请求
处理完成
处理出错
清理资源
重试后仍失败
系统关闭
空闲
处理中
成功
失败

关键要素:

  • 状态:[*](初始状态)、状态名(普通状态)
  • 转换:状态1 --> 状态2: 事件
六、饼图(Pie Chart)

饼图用于展示数据的比例关系。

基本语法:

35%25%20%20%市场份额分布产品A产品B产品C产品D

关键要素:

  • 标题:title 定义图表标题
  • 数据项:"名称" : 值 格式定义各部分比例
七、部署图(Deployment Diagram)

部署图用于展示系统的物理架构和组件分布。

基本语法:

开发环境
生产环境
本地数据库
开发机
数据库服务器
Web服务器
开发人员
用户

关键要素:

  • 节点:服务器、设备等
  • 连接:表示组件之间的关系
  • 子图:subgraph 分组相关组件
八、用例图(Use Case Diagram)

用例图用于展示系统的功能和参与者之间的关系。

基本语法:

登录
注册
查询信息
管理用户
系统设置
用户
系统
管理员

关键要素:

  • 参与者:矩形表示
  • 用例:椭圆表示
  • 关系:箭头表示参与者与用例之间的交互
九、旅程图(Journey Diagram)

旅程图用于展示用户与系统交互的完整过程。

基本语法:

中等困难容易简单
浏览商品
浏览商品
简单
查看商品列表
查看商品列表
容易
筛选商品
筛选商品
简单
查看商品详情
查看商品详情
下单支付
下单支付
中等
添加购物车
添加购物车
中等
填写收货信息
填写收货信息
容易
选择支付方式
选择支付方式
困难
完成支付
完成支付
用户在线购物体验

关键要素:

  • 阶段:section 定义用户旅程的不同阶段
  • 活动:每行定义一个活动,格式为活动名称: 重要性: 难度
十、配置与高级技巧
  1. 主题设置:
A
B
C
  1. 样式自定义:
开始
判断
  1. 注释:
A
B
C
总结

Mermaid 通过统一的文本语法,让开发者和非技术人员都能轻松创建专业的可视化图表。无论是技术文档、项目规划还是系统设计,Mermaid 都能提供直观且规范的图表支持,大大提高沟通效率和文档质量。

http://www.lryc.cn/news/590678.html

相关文章:

  • 网络基础10 长途互联--WAN广域网技术
  • 多维动态规划题解——最小路径和【LeetCode】记忆化搜索翻译为递推写法
  • Cursor区域限制问题解决方案:AI模型访问技术突破与环境隔离实践
  • DeepSeek(18):SpringAI+DeepSeek大模型应用开发之会话日志
  • 6.删除-demo
  • Lsposed/Xposed
  • MySQL学习——面试版
  • C++ shared_ptr 底层实现分析
  • 元宇宙经济:虚实融合引发经济新变革
  • XC7A75T‑2FGG484I Xilinx Artix‑7 FPGA AMD
  • 图机器学习(9)——图正则化算法
  • 第13章 AB实验平台的建设
  • Qt 的信号槽机制中,使用 `connect` 函数时,第五个参数是 **连接类型(Connection Type)**,
  • 代码随想录算法训练营第二十二天
  • 2.PCL 对于点云的读写
  • 《python语言程序设计》2018版第8章5题编写函数统计特定不重复字符串s2在s1中的出现次数
  • lua(xlua)基础知识点记录一
  • 基于阿里云云服务器-局域网组网软件
  • 低精度定时器 (timer_list) 和 高精度定时器 (hrtimer)
  • 如何加快golang编译速度
  • VIVADO技巧_BUFGMUX时序优化
  • 助力品牌从系统碎片化走向IT一体化建设,实现全渠道业务协同!——商派“数智化IT轻咨询”
  • tools的作用:预览
  • 硬件产品的技术资料管控是确保研发可追溯、生产可复制、质量可控制的核心环节。
  • MybatisPlus-11.IService的批量新增
  • 《十万线段绘乾坤:Canvas离屏渲染深度剖析》
  • 零基础学Vue3组件化开发
  • java操作Excel两种方式EasyExcel 和POI
  • Vue加密文章密码 VuePress
  • 使用defineExpose暴露子组件的属性和方法、页面生命周期onLoad和onReady的使用