Zenn
📝

PlantUMLの導入と使い方

2023/12/16に公開
PlantUML
tech

このページでは、PlantUMLの導入と使い方について記述します。

PlantUMLは

PlantUMLは、テキストベースのユーザーフレンドリーなモデリングツールで、UML（Unified Modeling Language）図を作成するためのオープンソースのソフトウェアです。PlantUMLを使用すると、プログラマーやソフトウェアアーキテクトは、コードやドキュメント内でUML図を簡単に作成できます。

導入方法

  1. Javaのインストール: PlantUMLはJavaで動作するため、最初にJavaをインストールする必要があります。Oracleの公式ウェブサイト から最新のJDK（Java Development Kit）をダウンロードし、インストールします。
  2. Graphvizをインストール:Graphvizは図形の描きだしに必要なライブラリです。 シーケンス図とアクティビティ図はなくても描けるが、一緒に導入することを勧めます。
    ダウンロードはここから
  3. PlantUMLをインストール:VSCodeの拡張機能からPlantUMLをインストール

使用方法

PlantUMLでは、テキストファイル内でUML図を記述します。以下に基本的なPlantUMLのシンタックスと例を示します。

  1. クラス図の例:
@startuml
class MyClass {
  + attribute1: type
  - attribute2: type
  + operation1()
  - operation2()
}
@enduml
  1. シーケンス図の例:
@startuml
participant Actor
participant Object
Actor -> Object: Message
Object -> Object: Message
@enduml
  1. コンポーネント図の例:
@startuml
component Component1
component Component2
Component1 --> Component2
@enduml

これらは、PlantUMLの基本的なシンタックスの一部であり、さまざまなUML図を作成するための要素です。詳細なPlantUMLのシンタックスと使用方法については、PlantUMLの公式ドキュメント を参照してください。

参考文献

・VSCodeにPlantUMLを導入する手順
・chatGPT　3.5

Discussion