IntelliJでPlantUMLを使う

テキストでUMLが作れるPlantUML

PlantUMLは、図(UML)を、テキストから生成できるツールです。

PlantUML 概要

ドキュメントなどを書く時に、図を書くのに時間がかかりますが、PlantUMLを使うと、テキストをタイプするだけなので、変更も簡単です。

たとえば、こういうテキストを書きます。

(A) <-- (B)
(B) <-- (C)
(A) <-- (C)

こういう図が生成されます。

名称未設定

便利!

IntelliJで使えるように設定する

僕はふだんドキュメントを書くときは、IntelliJ上で、Markdownで書いてます。

Markdownで記述したドキュメント内にPlantUMLが埋め込めると便利なので、そのように設定していきます。

Graphvizのインストール

PlantUMLは、図の生成にGraphvizを使っているので、インストールしておきます。

brew install graphviz

インストールされたパスを確認します。

$ which dot
/usr/local/bin/dot

PlantUML integrationのインストール

IntelliJのプラグイン設定から、PlantUML integrationをインストールします。

PlantUML integration - Plugins | JetBrains

そして、PlantUML integrationの設定に、Graphvizの実行ファイルとして、先ほどのパスを指定します。

スクリーンショット 2019-10-04 18.07.45

PlantUML frameworkのインストール

最後にMarkdownの設定から、PlantUMLの本体をインストールします。

スクリーンショット 2019-10-04 18.08.21

これで、 設定は完了!

.mdファイルに、PlantUMLを書く

Markdown中にコードを書くように、PlantUMLの記述をします。言語指定は、pumlとします。

# PlantUML

```puml
(A) <-- (B)
(B) <-- (C)
(A) <-- (C)
```

プレビューされると、こんな感じ。

名称未設定

ドキュメントに図が追加できて、わかりやすくなります!

About katty0324

Comments are closed.

Scroll To Top