こんにちは。マニュアル作成・ナレッジ共有ツール「NotePM」ブログ編集局です。
クラス図のテンプレートと例文をご紹介します。
関連記事：Markdownの書き方（PlantUML記法） – NotePM
クラス図とは？
クラス図はUML（統一モデリング言語）で描かれる図の一つです。クラス図はオブジェクト指向モデリング、およびオブジェクト指向プログラミングで利用されます。ソースコードにおけるクラスやインタフェースをモデリングし、プロジェクト関係者がシステム構造を理解しやすくなります。
クラス図では主にパッケージ、インターフェース、そしてクラスの3モデルを用います。
WEB上で簡単にクラス図の作成・管理を行えるツール「NotePM」
クラス図の目的
クラス図を作画する目的はシステムの可視化にあります。文章だけで示されるのと比べて、モデリング（可視化）することでシステム全体の構成が分かりやすくなります。クラス同士の関係であったり、その粒度を俯瞰的に確認できます。システム規模が大きくなればなるほど全体像をつかみづらくなり、似たようなクラスが作成されたり、煩雑化するのを防げます。
モデリングソフトウェアによってはクラス図からスケルトンコードの生成が可能であり、設計からコードの記述までのステップを簡略化できます。
クラス図の書き方
クラス図の基本となるのはクラスになります。クラスやインタフェースは以下の情報を保持しています。
- クラス名
- 属性
- 名前
- データ型
- 可視性
- 規定値
- 操作（メソッド）
- 名前
- 可視性
- 引数の名前とデータ型
- 返値のデータ型
可視性は以下の4つが指定できます。
- public
どこからでも閲覧可能 - protected
自クラスおよび特化クラスからのみ閲覧可能 - private
自クラスからのみ閲覧可能 - package
同じパッケージからのみ閲覧可能
パッケージはクラスやインタフェースを囲む形で定義されます。パッケージはパッケージ名のみを持ちます。
クラスやインタフェースは関係性を定義します。それは依存、汎化、継承、多重度などになります。
WEB上で簡単にクラス図の作成・管理を行えるツール「NotePM」
UMLサンプル例
```class クラス名1 {型 属性名型 属性名 = 規定値返値 メソッド名()返値 メソッド名(引数の型 引き数名)}class クラス名2 extends 継承元クラス名 {型 属性名型 属性名 = 規定値返値 メソッド名()返値 メソッド名(引数の型 引き数名)}クラス名1 "1" *-- "n" クラス名2 : 多数クラス名1 o-- クラス名2 : 集約クラス名1 --> "1" クラス名2```