vscode用plantuml插件画uml图

xyrui

已于 2022-09-27 10:06:04 修改

阅读量1.2k

点赞数 1

分类专栏：工具文章标签： vscode 前端 ide

于 2022-09-27 10:01:26 首次发布

本文链接：https://blog.youkuaiyun.com/xyrui/article/details/127065920

版权

工具专栏收录该内容

1 篇文章

订阅专栏

本文介绍如何在VSCode中利用PlantUML插件创建.md文件，并绘制序列图来展示软件系统的交互过程。包括配置环境、编写基本语法及两个具体的案例。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1、安装vscode插件：

Markdown Preview Enhanced
PlantUML

2、新建一个.md文件

写法可参考这个网站的例子，有分类和不同的例子：https://real-world-plantuml.com/

例子1：

```puml

@startuml

hide footbox

actor User

activate User

note left of User

编写测试用例

end note



User --> RF: Run

deactivate User

activate RF

note left of RF

'1、将RetrieveData

     翻译为测试脚本

2、将Check记录为

     CheckList

end note



RF --> PSTT: SendScript

deactivate RF



PSTT --> RF: ScriptRecieved

RF --> PSTT: Start

PSTT --> RF: Started

activate PSTT

note right of PSTT

1、加载所有的获取数据的规则与方法

2、开始执行脚本

3、执行过程中，按照获取数据的规则

     与方法保存数据

4、汇总获取到的数据，形成测试报告

5、获取数据的规则与方法在PSTT中

     定义，RF可以按照方法名称调用

end note



PSTT --> RF: Report

deactivate PSTT

activate RF

note left of RF

1、记录各个PSTT的

     测试报告

2、按照CheckList

     中的检查规则，检查

     测试是否每个Check

     项目是否为True

3、所有检查项为True则

     测试通过

end note



RF --> User: Test Result(Pass/Fail/Error)

deactivate RF



@enduml

```

例子二：

```puml
@startuml
title audio_rxtx Interaction Diagram\nBroadcast

participant proc
participant sender_broadcast
participant receiver_incompat

activate proc #FFBBBB

autonumber

proc --> receiver_incompat: configure & start
receiver_incompat -> receiver_incompat: start listening for audio
activate receiver_incompat #FFBBBB

proc --> sender_broadcast: configure & start
activate sender_broadcast #FFBBBB
sender_broadcast -> sender_broadcast: start sending audio\n(skip /offer)
activate sender_broadcast #FF0000

loop
sender_broadcast --> receiver_incompat: /audio

receiver_incompat -> receiver_incompat: check compatibility
' activate receiver_incompat #DarkSalmon
activate receiver_incompat #0000FF
receiver_incompat -> receiver_incompat: start/continue playout
' deactivate receiver_incompat
end

' sender_broadcast --> receiver_incompat: /audio
' activate receiver_incompat #0000FF

proc --> receiver_incompat: terminate

receiver_incompat -> receiver_incompat: stop playout
deactivate receiver_incompat

receiver_incompat --> sender_broadcast: /pause

sender_broadcast -> sender_broadcast: ignore pause

receiver_incompat -> receiver_incompat: shutdown
deactivate receiver_incompat

@enduml
```