in UML Markdown ~ read.

在VSCode中使用Markdown绘制UML图

在VSCode中使用Markdown绘制UML图

安装工具

  • VSCode
    VisualStudioCode代码编辑器
  • Graphviz
    开源图形可视化软件
  • java
    PlantUML需要java环境

安装插件

  • Markdown All in One
    VSCode中支持Markdown(键盘快捷键、目录、自动预览等)
  • Markdown Preview Enhanced
    可以对Markdown做增强预览,比如支持各种绘图等
  • PlantUML
    一款很强大的,并且可以绘制各种图形的脚本语言。需要安装java
  • markdownlint
    是让VSCode对Markdown文档进行标记,检查。他可以提示你写的markdown是否标准

设置环境变量

  • JAVA_HOME=D:\Program Files\Java\jdk1.8.0_73
  • GRAPHVIZ_DOT=D:\Program Files (x86)\Graphviz2.38\bin\dot.exe

使用

示例语法

```plantuml
@startuml
class BaseClass
namespace net.dummy #DDDDDD {
    .BaseClass <|-- Person
    Meeting o-- Person
    
    .BaseClass <|- Meeting
}
namespace net.foo {
net.dummy.Person  <|- Person
.BaseClass <|-- Person
net.dummy.Meeting o-- Person
}
BaseClass <|-- net.unused.Person
class net.unused.Person {
+ public void test();
}
@enduml
```

效果图

eg_plantUML

参考 码道人博客