はじめに
Unityの入門書が楽しかったので、UMLに整理しようと思っております。
まずはPlantUMLを使ってUMLを作成する方法を得ました。
PlantUML自体のインストール方法は、別記事で語らせていただきました。
でもいざPlantUMLでUMLを作成しようとしましたところ、コードの量が多いと相応にUMLを作成するのが大変だということが分かりました。そこで、PlantUMLをダウンロードしようとした時に見つけた、C# to PlantUMLという拡張機能を使うことにしました。
こちらの記事では、このC# to PlantUMLという拡張機能の使い方を説明させていただきます。
参考とさせていただきましたサイト様は以下となります。
目次
C# to PlantUMLのインストール方法
インストールの方法はシンプルです。
VS CodeのExtensionsで拡張機能を探して、インストールします。
UMLの生成方法
UMLの生成には、VSCodeのファイル -> Add folder to workspaceを選択します。
するとフォルダを選択することができますので、UnityのScriptsフォルダを選択いたします。
これによりScriptsフォルダがVSCodeのワークスペースに追加されているはずです。
次にVSCodeでShift + Command + Pでコマンドの実行をします。
実行するコマンドはcsharp2plantuml.classDiagramとなります。
実行しますと、Scriptsフォルダの中にplantumlフォルダが作られているはずです。
plantumlフォルダの中にinclude.pumlとクラスごとのファイルが作成されております。
include.pumlはその他クラスのファイルを参照する形式となっておりましたので、こちらでUMLを作成しますと、全体図が見えるようになります。
UMLの生成には、Macでしたらoption + Dで生成することができます。
生成しますと、ダイアグラムのビューが表示されます。
生成したUMLの保存方法
include.pumlファイルを開いた状態で、そのファイルの内容の上で右クリックをします。
「ファイル内のダイアグラムをエクスポート」を選びます。
そのあとに保存するファイル形式を選びますと、out/plantumlというフォルダが作成されます。
この中に出力結果が表示されます。
なんと素晴らしい機能でしょう！
