PlantUMLとは？

PlantUMLは、テキストベースでUML図（ユースケース図、シーケンス図、クラス図など）を作成できるツールです。シンプルな記法で図を自動生成でき、バージョン管理にも適しています。

基本的な使い方

1. PlantUML記法でファイルを作成

拡張子は .pu や .puml など。例：

@startuml
actor User
User -> System : リクエスト
System --> User : レスポンス
@enduml

2. 図の生成方法

  • オンラインエディタ（PlantUML Online Server など）を使う
  • ローカルでコマンドラインから生成（Javaが必要）
    • 例: java -jar plantuml.jar ファイル名.pu
  • VS Code拡張機能（PlantUML）を使うと、エディタ内でプレビュー可能
    • settings.json を開く（Ctrl + Shift + P →「Preferences: Open Settings (JSON)」）
    • 以下を追加： 
      "plantuml.server": "https://kroki.io/plantuml",
"plantuml.render": "PlantUMLServer"
    • plantuml.server には、上記の Kroki（https://kroki.io/plantuml）のほか、公式サーバ（https://www.plantuml.com/plantuml）も指定できます。どちらを使っても図は生成されます（講義スライドの図は公式サーバを利用しています）。

3. よく使うUML図の例

ユースケース図

@startuml
actor User
User -- (混雑状況を確認)
User -- (混雑予測グラフを閲覧)
@enduml

シーケンス図

@startuml
actor User
participant "食堂システム" as System
User -> System : 混雑状況を問い合わせ
System --> User : 混雑状況を返す
@enduml

参考リンク

注意

  • ファイルの先頭と末尾に @startuml と @enduml を必ず記述してください。
  • 日本語を使う場合は、文字化け対策としてUTF-8で保存してください。
  • 詳細な記法や応用例は公式サイトを参照してください。