怎么用
- 选一个和你要画的图最接近的模板,或直接粘贴已有的 PlantUML 代码。
- 改左侧的文字,右侧约 1 秒后自动更新;出错时图里会标出出错的行。
- 下载 SVG 放进文档或网页,下载 PNG 发给同事;复制分享链接可以把整张图连同代码发给别人继续改。
支持的图表类型
| 开头写法 | 图表 |
|---|---|
@startuml … @enduml | 时序、用例、类、活动、组件、状态、部署、ER 图 |
@startgantt | 甘特图(项目计划) |
@startmindmap | 思维导图 |
@startwbs | 工作分解结构 WBS |
@startjson / @startyaml | JSON、YAML 数据结构 |
@startsalt | 界面线框图 |
nwdiag { … } | 网络拓扑图 |
!include <C4/C4_Container> | C4 架构图(内置标准库) |
常用语法速查
| 写法 | 作用 |
|---|---|
A -> B : message | 实线箭头(同步调用) |
A --> B | 虚线箭头(返回) |
alt / else / end | 条件分支 |
loop … end | 循环 |
:step; | 活动图里的一步 |
if (paid?) then (yes) | 活动图判断 |
|Sales| | 活动图泳道 |
note right: text | 注释 |
skinparam monochrome true | 黑白输出,适合打印 |
' comment | 单行注释(单引号开头) |
常见问题
PlantUML 是什么?
PlantUML 是用纯文本描述图表的开源工具:写一行「买家 → 业务员 : 询价」就生成一条时序消息。文本可以放进 Git、文档和工单里,改起来比拖拽画图快,也方便团队协作和版本对比。
我的图会被保存或公开吗?
不会。预览时代码发送到本站服务器渲染成图片后立即丢弃,不保存、不记录;服务器以沙箱模式运行 PlantUML,不能读取文件或访问网络。分享链接把代码压缩在链接里,只有拿到链接的人能看到。
为什么中文显示正常、导出 PNG 也清晰?
预览和 SVG 由你的浏览器用本机字体显示;PNG 也是在浏览器里按 2 倍分辨率从 SVG 生成,所以中文、日文等文字不会变成方框。
支持 !include 引用外部文件吗?
为了安全,不能引用本地文件或网址;PlantUML 自带的标准库可以用,例如 C4 架构图库(C4/C4_Container)和 AWS 等图标库。