🐷

PlantUMLでiOSアプリのクラス図を作成する

2021/09/20に公開

iOS

はじめに

PlantUMLを使用してiOSアプリのクラス図を作成します。
PlantUMLはiOSアプリ開発以外でも暗鈴などの作成全般に使用できるツールですが、今回はiOSのプロジェクトベースで説明します。

ツールについて

PlantUML

VSCodeで使用することができ、プレビューしながらコードベースでクラス図を作成することができます。
esaに直接書き込むこともできます。

ほかにdraw.ioなどの作図ツールもあります。
https://app.diagrams.net/

PlantUMLの環境構築

Javaのインストール

$ brew install java

$ sudo ln -sfn $(brew --prefix)/opt/openjdk/libexec/openjdk.jdk /Library/Java/JavaVirtualMachines/openjdk.jdk

$ $ brew install graphviz

VSCodeの拡張にPlantUMLを追加

一番上のものをインストールします。

クラス図を書く

今回はRepositoryとUserという２つのstructを例にクラス図を作成します。

Model

@startuml Models

namespace Model #ECEFF4 {

    class Repository <<S, #ffeecc)>> {
        let id: Int64
        let name: String
        let description: String
        let owner: User
    }
    
    class User <<S, #ffeecc)>> {
        let id: Int64
        let login: String
    }
    note left : User.swift

}