Mermaid記法について - CASru-GAME/TeamGameDevBootcamp GitHub Wiki

mermaid記法はクラス図やシーケンス図といった図を文章中にグラフィカルに表示することが出来る便利な記法です。 これを使ってクラス図を作ればコーディングの役に立つのではないでしょうか。

参考

mermaidについて

• https://dev.classmethod.jp/articles/hotlimit-mermaid/
• https://qiita.com/t_narita/items/2cc69fc1d481e4ee6b08

クラス図について

• https://cacoo.com/ja/blog/how-to-write-class-diagram/

githubのwiki上で書くとき、折り畳みに複数のMermaid形式を入れると１つしか表示されないので(バグかも)注意してください。

例：

classDiagram
    Animal <|-- Duck
    Animal <|-- Fish
    Animal <|-- Zebra
    Animal : +int age
    Animal : +String gender
    Animal: +isMammal()
    Animal: +mate()
    class Duck{
      +String beakColor
      +swim()
      +quack()
    }
    class Fish{
      -int sizeInFeet
      -canEat()
    }
    class Zebra{
      +bool is_wild
      +run()
    }