Gaming Life

一日24時間、ゲームは10時間

VSCode+PlantUMLでクラス設計図が簡単に作れる

 ブログ執筆を始め、ずっとエディタはAtomを使っていたのだが、Gitの設定をいじっていたらパッケージインストールで認証エラーが出るようになった。解決の仕方も分からなかったので、この機会だしVSCodeに移行してみた。

 こんな感じで記事を書いてる。

f:id:ai_gaminglife:20181011000348p:plain

 動作も軽快、UIもわかりやすく、Markdown PreviewCSSがちょっと見辛い以外は不満はない。


 で、本題。これまで私は何本かゲームを作ってきたが、どれも開発期間は長くて1ヶ月。行き当たりばったりでクラスを作り、結果相互参照連発しコンパイル時間が伸びる酷い設計のプログラムを何度も書いた。

 現在作り始めているUnityゲームは相当大規模になりそうで、こんな行き当たりばったり設計しててはあらゆる機能を持ってしまう(所謂)神クラスが誕生してしまいかねない。

 じゃあどうするかっていうと、UMLを使ったクラス図を作って事前に設計したくなる。しかし、以前まではWordかdraw.ioでテキストボックスをちまちま配置し、コネクタ同士を矢印で繋げて、コメント書いて……みたいな方法で作っていた。見た目は凝れるが、あまりに面倒。大規模だと流石にやってられない。

 PlantUMLを使えばそんな面倒な作業からおさらばできる。

plantuml.com

 簡易な文法ながら高機能で、複雑なクラス図を自動で作成、描画できる。

 PlantUMLを使いはじめて2時間位でこれくらいは作れてしまった。

 PlantUMLの優れているところはVSCodeに専用の拡張機能があることで、これを使うことでサイドタブにクラス図を描画させながら快適なVSCode環境で書くことができる。

 導入には以下のサイトが参考になるだろう。

注意

 PlantUMLはコメントを書きたい時は、

' 1行コメントはこれ
/*
複数行のコメントは
こんな感じ
*/

とすれば良い。