vscode PlantUML

配置

PlantUML插件需要依赖Graphviz或是plantuml.jar两个具体的实现工具中有一个就行了。

• plantuml.jar画出来的比较简洁，需要安装一个jre再下载一个plantuml.jar。
• Graphviz画出来比较好看，但是要下载安装Graphviz并安装， 把里面的bin目录添加到环境变量PATH。命令行输入dot -version确认安装成功。

有了依赖的工具以后，在vscode里安装PlantUML插件，点击插件介绍页面上的齿轮按钮打开配置页面。

如果是用plantuml.jar依赖的话，在plantuml.jar一项指定plantuml.jar的路径与文件名。

页面上还可以指定「在 setting.json 中编辑」可以打开全局的setting.json文件。

如果针对每个项目有不同的配置，那么可以在项目目录中的.vscode/setting.json 指定具体的配置。

常用的配置内容如一：

{
    "plantuml.jar": "C:/programe/editor/plantuml.jar",
    "plantuml.exportFormat": "svg",
    "plantuml.urlFormat": "svg",
    "plantuml.exportMapFile": true,
    "plantuml.diagramsRoot": "docs/uml/src",
    "plantuml.exportOutDir": "docs/uml/out",
    "plantuml.jarArgs": [ ]
}

plantuml.jar的参数有指定图片大小的，如果发生导出图片不完整的情况， 可以指定一个大一点的参数：

	{
	
    "plantuml.jarArgs": [ "-DPLANTUML_LIMIT_SIZE=819" ],
    
	}

基本操作

UML的代码里最好在@startuml后面加上图例的标题：

@startuml wsgi-example
Client -> HttpServer: request

HttpServer -> WebApp: application_callable()
note right: application_callable(environ, start_response)

WebApp -> HttpServer: start_response()
note right: start_response(status, headers, exc_info)

WebApp -> HttpServer: return iterator

HttpServer -> Client: response
@enduml

Ctrl + Shift + P 打开命令列表：

• Preview current diagram 预览生效的UML图，快捷键是Alt + D。
• Export current file diagram 导出当前文件的UML
• Export current cursor diagram 导出当前光标所在的UML