vscode中plantuml的使用
在平時(shí)寫文檔中需要進(jìn)行畫圖,hsing給我推薦了一個(gè)高效又簡(jiǎn)潔的工具--Plantuml腺占。詳細(xì)可參考文檔http://plantuml.com/zh/
平時(shí)工作中使用的是vscode衰伯,所以在這里只介紹vscode中Plantuml的使用铡羡。
1.在vscode的擴(kuò)展商城中輸入Plantuml烦周, 點(diǎn)擊進(jìn)行安裝怎顾。
2.在Plantuml中我們使用偽編程語言來生成圖表槐雾。代碼的文件的擴(kuò)展名可以如一下:*.wsd, *.pu, *.puml, *.plantuml, *.iuml
時(shí)序圖
@startuml
scale 3
Amber -> Hsing : test
@enduml
按Alt+D或者Option+D可預(yù)覽生成的圖表
注意如果你的電腦上沒有安裝java需要進(jìn)行安裝
可以使用 -->繪制虛線
@startuml
a -> b : To request
b --> a : To response
@enduml
3.聲明參與者
關(guān)鍵字participant可以用于改變參與者的先后順序株灸。
角色分為:actor boundary control entity database
@startuml
actor Foo1
boundary Foo2
control Foo3
entity Foo4
database Foo5
collection Foo6
Foo1 -> Foo2 : To boundary
Foo1 -> Foo3 : To control
Foo1 -> Foo4 : To entity
Foo1 -> Foo5 : To database
Foo1 -> Foo6 : To collection
@enduml
使用關(guān)鍵字order自定義順序打印參與者
@startuml
participant Last order 30
participant Middle order 20
participant First order 10
@enduml
4.修改箭頭的樣式
箭頭樣式有以下幾種
-表示一條丟失的消息:末尾加x
-讓箭頭只有上半部分或者下半部分:將<和>替換成\或者/
-細(xì)箭頭:將箭頭標(biāo)記寫成兩次(如>> 或 //)
-虛線箭頭: 用--替代 -
-箭頭末尾加圈:->o
-雙向箭頭: <->
@startuml
hsing -> amber
hsing ->> amber
hsing <-> amber
hsing ->o amber
hsing --> amber
hsing -/ amber
hsing -\ amber
hsing -// amber
hsing -\\ amber
hsing //-- amber
hsing ->x amber
@enduml
5.修改箭頭的顏色
使用記號(hào)修改箭頭顏色
@startuml
hsing -[#red]> amber
amber -[#pink]-> hsing
hsing -[#blue]// amber
@enduml