1. 経緯
現在、取り組んでいる開発でUML図書きたいなと思いました。
開発環境を、できるだけPHPStormで完結させるようにしていたので、どうせならUML書くのもPHPStormでやろうと調べました。
2. PlantUML
UMLを書くことに特化した言語です。
書いたコードを読み取り、UML図をレンダリングします。
参考:https://plantuml.com/ja/
3. 導入方法
① PHPStormにPlantUMLのプラグインをインストールする。
PHPStormの File > Settings > Plugins から「PlantUML integration」というプラグインをインストール&PHPStormの再起動を行います。
② Graphvizをインストール
シーケンス図(クラス間のやり取りを時系列で表した図)以外をレンダリングしたい場合、必要になるそうです。こちら からダウンロードできます。
③ PlantUMLファイル作成
他のファイルを追加するときと同じ要領で作成できます。
New > PlantUML File を選択し、ファイル名を入力します。
ここで、作りたい図がどれなのか選択すると、それに応じたテンプレートが自動で作成されます。
4. まとめ
今回PHPStormでPlantUMLを書き、UML図を作成するところまで行いました。コードベースで作成ということでデザインも崩れにくいですし、バージョン管理もしやすいのが良いですね。