转载

[TIL] 在 vscode 上面安裝並且使用 PlantUML

[TIL] 在 vscode 上面安裝並且使用 PlantUML

前提

寫作技術文章的時候,經常需要各種 UML (Unified Modeling Language) 所繪製出來的圖形。雖然學生時代都會學過這個,但是工作之後其實不容易透過良好的工具來繪製。

通常在 MacOSX 繪製經常使用 OmniGraffle (其實我有買)或是 Lucidchart ,但是要安裝這些軟體可能沒有那麼方便,或是拉來拉去本身也是很讓人困擾(美工苦手)。

使用文字敘述來繪圖的工具一直是我最愛 ( LaTex 愛好者),所以進了公司之後聽說過了 PlantUML 就一直很喜愛。 但是這兩天好奇因素之下研究了一下跟 vscode 整合,並且把可能遇到的問題分析給大家。

什麼是 PlantUML

可以快速看一下 什麼是 PlantUML 介紹 ,或是去 PlantUML 官方網站 了解。

PlantUML 透過簡單的語法可以繪製出 UML ,對於要做系統設計架構圖或是要做系統說明的人其實很方便。

比如說一個 use-case diagram 如下:

[TIL] 在 vscode 上面安裝並且使用 PlantUML

而且 PlantUML 支援相當多種 UML Diagram

  • 时序图
  • 用例图
  • 类图
  • 活动图
  • 组件图
  • 状态图
  • 对象图
  • 部署图
  • 定时图

相當的方便。

如何在 VSCODE 上面安裝

VSCode 的 PlantUML 具有相當多的特點:

  • Preview Diagram
  • Export Diagrams
  • Format PlantUML code (我很需要)
  • All type syntax highlight.
  • Auto Include.
  • MarkDown integrating support. View Demo (有點威)

安裝 PlantUML plugin

套件節點

[TIL] 在 vscode 上面安裝並且使用 PlantUML

想要試著跑但是會跑出錯誤。

No Java runtime present, requesting install.

請看以下方式解決。

解決在 OSX 10.11 之後無法順利更新 Java 的錯誤

  • 一開始試著在 vscode 裡面跑 java 相關指令會跑出
No Java runtime present, requesting install.
  • 就算你試著更新 MacOSX 的 Java (參考 這篇官方文件 ) 還是會跑出錯誤,那麼就要 安裝”下載 - Java for OS X 2017-001”這個套件 。
  • 完整錯誤請查看 這個說明 。

更新 PlantUML.jar

如果 vscode 套件裡面的版本太舊,可以考慮去 下載 。

懶得安裝? 也是有線上版可以用

https://www.planttext.com/

提供了線上的版本,雖然沒有一些相關功能可以使用,但是臨時要用還是可以使用。

[TIL] 在 vscode 上面安裝並且使用 PlantUML

總結:

Reference

  • PlantUML 官方網站
  • 用筆記也可以管理專案(一):PlantUML
  • PlantUML安装和使用
原文  http://www.evanlin.com/til-vscode-plantuml/
正文到此结束
Loading...