PlantUMLのテクニック

1738 ワード
シーケンス図 plantuml uml クラス図 uml テキストリンク

PlantUMLというフリーのUML記述ツールが有る。これでクラス図やシーケンス図を作成する場合、構成管理（svnやGIT）できるようになるため、重宝する。

小ネタとちょっとしたテクニック、以下に記載しておく（随時追加）。なお、インストール方法や基本的な使い方は他の記事に委ねる。

画像のサイズ制限

PlantUMLでは画像サイズが4096に制限されます（詳細）。この制限によって、少し大きなシーケンス図なんかを書こうとすると、画像が途中で切れてしまうことがある。

この制限を回避するには、環境変数PLANTUML_LIMIT_SIZEを設定する必要がある。
[コントロール パネル] > [システムとセキュリティ] > [システム] > [システムの詳細設定] > [詳細設定]タブ > [環境変数(N)...] > [新規(W)...]
変数名:PLANTUML_LIMIT_SIZE
変数値:8192
※変数値は作成するUMLサイズに合わせて、適当な値を指定。

背景透過

以下を指定することでエクスポート時に背景を透過して出力することができる。
skinparam backgroundColor transparent

コメントの横並び

PlantUMLのシーケンス図では、基本的にコメントを同一の横位置に並べることができない。
以下のように/を先頭につけることでメッセージを横並びにできる。

@startuml
!pragma teoz true
note over Sally : Scared of Bob
/ note over Alice : initial state of Alice
/ note over Bob : initial state of Bob
Bob -> Alice : hello
& Alice -> Sally : hello from Bob
@enduml

参考:Multiple messages on same line in a sequence diagram