微知-plantuml常用语法和要点以及模板?(note over、create、box,endbox、alt,else,end, autonumber)
文章目录
- 常见语法
- 常用
- 线条类
- 实线虚线
- 斜箭头或奇数箭头 A ->(10) B: B->(10) A
- 分割线:newpage
- 颜色类
- 给箭头指定颜色 -[#red]->
- 给某个note加颜色: note over Alice, Bob #FFAAAA: xxx
- 给分组信息着色 alt#red
- 分组类
- alt xxx; else xxx; else xxx; end 多选1
- group xxx 分组
- loop 1000 times 循环
- 使用|||来增加空间
- 包裹box、end box
- 生命线 activate deactivate destroy
- Notes注释类
- 设置note位置
- 在某行左边注释: note left: abc
- 在某行右边注释: note right: abc
- 在某个泳道左边注释: note left of xxx: abc
- 在某个泳道右边注释: note right of xxx: abc
- 在某个泳道中注释: note over xxx: abc
- 在多个用到中注释: note over Alice, Bob : xxx
- 修改note形状和颜色
- 正方形:rnote over server
- 六边形:hnote over server
- 在多行或者多注释
- 在多个参与者添加备注 [across]
- 同一级对齐多个备注 [/]
- 序号类
- 自动添加序号 autonumber
- 自动添加每行序号:autonumber
- 高阶:自动指定起始值和跳变值
- 多序列号 autonumber 1.1.1, inc A, inc B
- 其他
- 泳道新建新对象 create
- 指定持续时间 teoz
- 常用链接
- 模板
- 附录
常见语法
常用
- \n换行
- -> 实线
- –> 虚线
- note over xxx: abc
- 泳道新建新对象 create
- box; end box
- alt; else; end
- autonumber
线条类
实线虚线
实线: ->
虚线:–>
斜箭头或奇数箭头 A ->(10) B: B->(10) A
使用 (nn) 选项(在箭头之前或之后)使箭头倾斜,其中 nn 是偏移像素的数量。
分割线:newpage
颜色类
给箭头指定颜色 -[#red]->
给某个note加颜色: note over Alice, Bob #FFAAAA: xxx
给分组信息着色 alt#red
可以给分组信息color[着色]。
分组类
涉及的关键字:
alt/else
opt
loop
par
break
critical
group
中文效果:
alt xxx; else xxx; else xxx; end 多选1
group xxx 分组
loop 1000 times 循环
使用|||来增加空间
包裹box、end box
可以使用box和end box画一个盒子将参与者包裹起来。
还可以在box关键字之后添加标题或者背景颜色。
生命线 activate deactivate destroy
关键字activate和deactivate用来表示参与者的生命活动。
一旦参与者被激活,它的生命线就会显示出来。
activate和deactivate适用于以上情形。
destroy表示一个参与者的生命线的终结。
Notes注释类
关键词:
note left
note right
end note
note left of xxx: abc
note right of xxx: abc
note over xxx: abc
设置note位置
在某行左边注释: note left: abc
在某行右边注释: note right: abc
在某个泳道左边注释: note left of xxx: abc
在某个泳道右边注释: note right of xxx: abc
在某个泳道中注释: note over xxx: abc
在多个用到中注释: note over Alice, Bob : xxx
修改note形状和颜色
使用 hnote 和 rnote 这两个关键字来修改备注框的形状:
hnote代表六边形(hexagonal)的备注框;
rnote代表正方形(rectangle)的备注框。
正方形:rnote over server
六边形:hnote over server
在多行或者多注释
在多个参与者添加备注 [across]
同一级对齐多个备注 [/]
序号类
自动添加序号 autonumber
自动添加每行序号:autonumber
高阶:自动指定起始值和跳变值
多序列号 autonumber 1.1.1, inc A, inc B
更高级参考官网详细说明
其他
泳道新建新对象 create
指定持续时间 teoz
使用teoz在图表中添加锚点,从而指定持续时间。
这里其实就是对每条消息添加{}标签 然后标签引用
常用链接
官网序列图: https://plantuml.com/sequence-diagram
官网颜色:
模板
@startuml
autonumber
actor "用户" as User
participant "浏览器" as Browser
participant "服务端" as Server #orange
activate User
User -> Browser: 输入 URL
activate Browser
Browser -> Server: 请求服务器
activate Server
Server -> Server: 模板渲染
note right of Server: 这是一个注释
Server -> Browser: 返回 HTML
deactivate Server
Browser --> User
@enduml
附录
plantuml详细指南,参考附件