search
LoginSignup
37

More than 5 years have passed since last update.

posted at

updated at

PlantUMLを使ってみる(MacOS) ~Visual Studio Codeでもっと使いやすく~

PlantUMLのjarファイルを入手

Graphviz(dot)をインストール

シーケンス図以外を書く場合に必要

※xcodeコマンドラインツールがインストールされていない場合はインストール

$ xcode-select --install
$ brew install graphviz

graphvizが使えるようになっているか確認

$ java -jar plantuml.1.2017.19.jar -testdot

試しに使ってみる

testUML.txt
@startuml plantuml_simple.png

Foo -> Bar : コメント
Foo <-- Bar

@enduml

画像ファイル生成

$ java -jar plantuml.1.2017.19.jar testUML.txt

確認すると
plantuml_simple.png

クラス図も描いてみる

公式サンプルから
http://plantuml.com/class-diagram

testUML_class.txt
@startuml
Class01 <|-- Class02
Class03 *-- Class04
Class05 o-- Class06
Class07 .. Class08
Class09 -- Class10
@enduml

同様に画像生成

java -jar plantuml.1.2017.19.jar testUML_class.txt

testUML_class.png

生成できた!

Visual Studio Codeでプレビューしながら使う

インストール

「拡張機能」から、検索バーに「PlantUML」と入力
「PlantUML(jebbs.plantuml)」をインストールしてVisual Studio Code再起動

確認

Visual Studio Codeでは、
拡張子を「.pu」とすると、PlantUMLファイルとして認識してくれる
先ほどのクラス図を元に、「testUML_class.pu」を作成し、Visual Studio Codeで開く

testUML_class.pu
@startuml
Class01 <|-- Class02
Class03 *-- Class04
Class05 o-- Class06
Class07 .. Class08
Class09 -- Class10
@enduml

そして、「option + D」
で、PlantUMLプレビュー表示(こんな感じです)
スクリーンショット 2017-11-28 0.55.40.png

テキスト編集すると、自動で図も入れ替わる(ちょっとラグはある)

出力

「Command + Shift + P」でコマンドパレットを開き、
「PlantUML: ファイル内のダイアグラムをエクスポート(Export Current File Diagrams)」を入力
好みの出力形式を入力して完了!

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
What you can do with signing up
37