PlantUMLとMermaidの記法を比較する
2022/2
/15
エンジニアの体の95%は寿司でできている
-- どっかの誰か大嘘
https://gyazo.com/82deb72bb8233cb08b8766119174705b
概要
GitHubがMarkdownでMermaidをサポートした
普段
PlantUML
ばかり書いているけれど
Mermaid
は書いたことがあまりない
PlantUMLについてはマニュアル見なくても
アクティビティ図
、コンポーネント図(
システム構成図
)、
シーケンス図
を平で書ける
よって
Mermaid
の書き方の感触を掴むためにいくつか書いて
PlantUML
と比較する
公式ドキュメント
PlantUMLのドキュメント
Mermaidのドキュメント
オンラインエディタ
PlantUMLオンラインエディタ
Mermaidオンラインエディタ
比較
PlantUMLとMermaidでシステム構成図を書く
PlantUMLとMermaidでシーケンス図を書く
PlantUMLとMermaidでアクティビティ図を書く
PlantUMLとMermaidでガントチャートを書く
PlantUMLとMermaidでステート図を書く
まとめ
表現力だけで言うなら
PlantUML
の方が上
Mermaid
の方は細かい調整ができないので、ある程度妥協が発生する
特に位置調整が弱い
Mermaid
の方が「何の図を書くか」を明示的に宣言するので、コードの可読性が高い
例えば
PlantUML
の
ステート図
と
シーケンス図
は記法が非常に似ているので、コードだけ読んだ時にどっちの図なのか判別しづらい
GItHub
上でドキュメントを管理する時に、表現を多少妥協できるなら
Mermaid
を採用する方が手軽
余談
僕が確認した限りでは、
GitHub
上の
reStructuredText
と
AsciiDoc
でもちゃんと
Mermaid
を描画してくれた