類別圖

classDiagram
  direction LR
  namespace zoo {
    class Animal~T~ {
      <<abstract>>
      +String name
      -int count$
      +speak()* String
    }
  }
  Animal <|-- Dog
  Keeper "1" --> "0..*" Animal : feeds
  Duck ()-- Quacks
  note for Dog "good boy"
  style Dog fill:#fef3c7

timeline:
  enter Dog slide-bottom, enter Animal-Dog fade
  enter Keeper slide-left, enter Keeper-Animal fade
  enter note:1 fade, highlight Dog outline

標頭與方向

標頭是 classDiagram 或 classDiagram-v2。只有標頭、沒有內容也是合法的空白圖。

direction TB(預設)、BT、LR、RL 可以自成一行寫在任何地方,寫了好幾次的話以最後一個為準。direction TD 會報錯,請寫 direction TB。結尾多一個 ; 沒關係(direction LR;)。

其他任何一行只要含有 direction TB、BT、RL 或 LR(在標籤、成員、note、關係標籤等等裡)都會報錯,因為 Mermaid 會把整行當成方向敘述、丟掉其餘的文字。請改寫文字,或把方向移到自己的一行。

accTitle: 文字 和 accDescr: 文字(或大括號的 accDescr { ... } 區塊)要用小寫,會設定圖的無障礙標題與說明。

檔案最上方的 YAML front matter(--- … ---)和 %%{init: ...}%% 指令會照 Mermaid 的方式讀進來,但設定還沒有套用:每個設定會給一個 warning,圖照畫、不套用。

只有整行、開頭第一個非空白字元是 %% 的那一行才是註解。行中間的 %% 在成員、標籤或 note 裡會當成文字保留,接在敘述後面(A <|-- B %% note)則報錯;註解請自成一行。

類別

類別名稱只能用英數字和 _。

寫法 說明
class Animal 宣告類別
class Animal { ... } 宣告類別與成員。{ 在第一行的結尾;} 可以自成一行、接在最後一個成員的行尾,或在同一行就把區塊關起來(class A { +int x }、class A {})
class Order["Order Line"] 標籤,畫出來取代名稱
Animal : +int age 在區塊外逐一加入成員
class Shelf~T~ 泛型,會畫成 Shelf<T>。泛型屬於類別第一次被提到的那一行:先寫 class A 再寫 class A~T~ 會報錯,之後換成別的泛型也會報錯。不能巢狀(~List~int~~ 報錯,請寫 ~List#lt;int#gt;~),也不能含有會開啟標籤的 <(~List<int>~);#lt; 之類的 entity code 會解碼,<br> 會換行
A~T~ --> B 泛型也可以寫在關係的兩端
<<interface>> 寫在區塊裡的第一行,或在類別宣告之後寫成 <<interface>> Shape。內容可以是任何文字;同一個類別再寫一個不同的註記會報錯
class Animal:::hot 套用 classDef(見樣式)
  • 關係裡提到的類別會自動宣告。
  • 同一個類別可以宣告很多次,成員會合併起來。同一個成員寫兩次就畫兩次。

成員

寫法 意思
+、-、#、~ 開頭 public、private、protected、package。記號後面的空格會保留(+ x)
結尾 * abstract:* 本身不畫,整行斜體。方法的 * 也可以緊接在 ) 後面(+run()* String)
結尾 $ static:$ 本身不畫,整行加底線
有 ( 的是方法 +mate(Animal partner) Animal:) 後面是回傳型別,畫出來時中間加 :,成為 +mate(Animal partner) : Animal
其他是屬性 String name:最後一個字是名稱,前面是型別
  • 成員型別裡的 ~T~ 也會畫成 <T>,例如 List~int~ ids;這裡的泛型可以巢狀(List~List~int~~ ids)。
  • 成員名稱可以用數字開頭,可以含有 -、. 或任何語言的字母。entity code 和字元參照會解碼(+#lt; x 畫成 +< x)。
  • ; 不能用來分隔成員:+int x; +int y 不論寫在區塊裡或 Animal : 後面都會報錯。每個成員請自成一行。
  • 區塊裡只有 %% 的一行會畫成名為 %% 的成員,不是註解。

關係

classDiagram
  Animal <|-- Dog
  Car *-- Wheel
  Team o-- Player
  Order --> Item
  Service ..> Logger
  Plugin ..|> Extension
  A -- B
  C .. D
  Customer "1" --> "*" Invoice : issues
寫法 意思
<|-- 繼承
*-- 組合
o-- 聚合
--> 關聯
-- 連結(實線)
..> 依賴
..|> 實作
.. 連結(虛線)
  • 每一種都可以反過來寫,例如 --|>、--*、<..;兩端也可以同時有箭頭,例如 <|--|>。
  • 線有兩種:-- 實線、.. 虛線。左端可以是 <|、<、*、o、(),右端可以是 |>、>、*、o、(),可以任意組合。
  • 多重性:任一端可以加上加引號的文字,A "1" --> "0..*" B。
  • 標籤:結尾加上 : 文字。標籤畫在線上,底下墊一塊主題 --siren-edge-label-fill 的底色;寬度超過 150px 會自己換行,和 Mermaid 一樣,<br> 也能換行。類別名稱、成員和 note 不會換行。
  • Lollipop 介面:Duck ()-- Quacks。() 那一端不會變成類別,而是畫成介面的圓圈。

Namespace

classDiagram
  namespace shapes {
    class Circle
    class Square
  }
  namespace io {
    class Reader
  }
  Circle --> Reader

namespace 名稱 { 開啟區塊、} 關閉;也可以寫在同一行(namespace io { class Reader })。區塊裡只能放類別宣告、note 和巢狀的 namespace:寫了關係、style、classDef、direction 或在區塊外加成員的那種寫法都會報錯,空的 namespace 也會報錯。

  • namespace 可以巢狀,寫成 namespace N { namespace M { ... } } 或用點分隔的名稱 namespace N.M { ... },兩種都畫成框 N 包著框 M。名稱裡有空格(namespace N M {)會報錯,請寫 NM 或 N_M。
  • 同一個 namespace 開了好幾次會視為同一個,所有區塊合併成一個框。
  • 寫在 namespace 裡的 note 會畫在它的框裡面。
  • 一個類別被放進兩個不同的 namespace 時,只留在第一個並報錯。

Note

  • note "文字":獨立的 note。
  • note for Dog "文字":附在類別旁邊。指到不存在的類別的話,note 還是會畫出來,只是沒有連到任何東西,並給一個 warning。

樣式

classDiagram
  class Order
  class Invoice
  class Payment
  style Order fill:#dbeafe,stroke:#2563eb
  classDef money fill:#dcfce7,color:#166534
  cssClass "Invoice,Payment" money
  • style 類別 屬性:值,...
  • classDef 名稱 屬性:值,...
  • cssClass "A,B" 名稱:類別清單要加引號。class Animal:::名稱 可以在宣告時直接套用。
  • 類別上的 style 一定贏過套用到它的 classDef,不管哪個先寫。
  • 套用一個沒有 classDef 定義的名稱只是 warning,類別照畫、不套樣式。
  • timeline 的 highlight 作用在類別上時,強調的邊框顏色和粗細會贏過作者寫的 stroke。
  • 值的規則和流程圖相同,見 流程圖的樣式。

互動

寫法 效果
click Dog href "網址" "提示" 連結
link Dog "網址" "提示" 連結
click Dog call fn("參數") "提示" 呼叫 callback
callback Dog "fn" "提示" 呼叫 callback

提示文字會以 tooltip 顯示,提示本身可以省略。網址的限制和流程圖相同。

Timeline 目標

元素 id 例子
類別 類別名稱(泛型不算在內) Animal(class Animal~T~)
關係 左邊-右邊(依書寫的左右),重複的加 #2 Animal-Dog、Keeper-Animal
namespace namespace:N,依區塊開啟的順序編號,外層先於內層 namespace:1
note note:N,依原始碼順序 note:1
  • Animal <|-- Dog 的 id 是 Animal-Dog,和箭頭方向無關,只看左右。
  • 開了好幾次的 namespace 沿用第一個區塊的 id。
  • 類別的成員和 lollipop 介面的標籤不能單獨當目標。

尚未支援

語法 目前的行為
class A 名稱(套用樣式類別) 報錯,請改用 cssClass "A" 名稱 或 class A:::名稱
反引號類別名稱、非 ASCII 類別名稱 報錯
click ... href "網址" "提示" _blank 報錯,類別圖的連結不能指定開啟方式