Practical usage of PlantUML – §3. クラス図 その1

まずは、UMLといえばクラス図だと思いますので、PlantUMLでクラス図を記述するたの書き方についてまとめたいと思います。

基本的な書き方

はじめに、PlantUMLにおけるクラス図の記述を以下に例示します。

基本的には、クラスの定義→ 定義したクラス間の関係を記述することになります。

これを、UML図として見ると以下のようになります。

Figure 1

適用範囲

クラス図に限らず、PlantUMLで記述する場合は @startuml ~ @enduml で囲まれた箇所がUML図として適用されます。これを記述しない場合は、テキスト全体がPlantUMLの適用範囲となるので注意が必要です。

コメント

PlantUMLでシングルラインのコメント文を記述する場合は、シングルクォーテーション「’」から開始します。また、複数行コメントの場合はスラッシュ+シングルクォーテーション「/’」と、シングルクォーテーション+スラッシュ「’/」を使用します。

クラスの定義

クラスを定義する場合は、 class キーワードに続けてクラス名を記述します。クラス名自体は、半角でも全角文字でも構いませんが、空白を含めないように注意が必要です。クラス名に空白を入れたい場合は、ダブルクォーテーション「”」で囲んでください。

また、 interface キーワードを使用することで、インターフェイスを定義することも出来ます。

さらに、クラス図には、 package を用いることもできます。

クラス間の関連

クラス間の関係は、ハイフン「-」を使用して表現します。「-」を使用すると実線で表示されますが、ドット「.」を用いると破線で表示できます。

 

まとめ

以上、簡単にですがPlantUMLにおけるクラス図の書き方をまとめました。今回は、アクセシビリティ(public, private, protected 等)や、抽象クラス、静的メソッド、仮想メンバの記述方法ついては省略しまた。また、クラス間の関連で言えば、継承や集約、コンポジションの記述方法も割愛してます。これらは、次回以降の投稿で取り上げたいと思います。

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください