PlantUML教程詳解

一、Plant3D教程

PlantUML是由Arnaud Roques開發的一種使用簡單文本語言描述UML圖形的工具。雖然PlantUML以其流程圖而聞名，但它也可以用於繪製Plant3D圖形。下面是一個簡單的Plant3D圖形的代碼示例：

@startuml
scale 1.5
!define ICONURL https://raw.githubusercontent.com/rabelenda/cicon-asset/main
!define ICONSIZE 64
!define BROKENIMAGE $ICONURL/main/broken.png
!define OBJECT_SIGNATURE_BGCOLOR #7FFF00

!define PlantIcon(TaskName, IconName) node "[[" + $ICONURL/planticon/${IconName}.png?sanitize=true&size=${ICONSIZE}|$TaskName" as $TaskName
!define WorkPackageIcon(TaskName, IconName) node "[[" + $ICONURL/workpackageicon/${IconName}.png?sanitize=true&size=${ICONSIZE}|$TaskName" as $TaskName
!define MarkIcon(IconName) node "[[" + $ICONURL/main/${IconName}.png?sanitize=true&size=${ICONSIZE}" as $TaskName
!define HelpIcon(IconName) node "[[" + $ICONURL/main/${IconName}.png?sanitize=true&size=${ICONSIZE}" as $TaskName

TaskName(Mechanical Engineering) #Powderblue {
  WorkPackageIcon(Sensors, sensors)
  WorkPackageIcon(Control Systems, controls)
  WorkPackageIcon(Airframe, airframe)
  WorkPackageIcon(Propulsion, propulsion)
  PlantIcon(Integration, integration)
  PlantIcon(Fabrication, fabrication)
  PlantIcon(Assembly, assembly)
  MarkIcon(Paint, paint)
  MarkIcon(Simulations, simulations)
  MarkIcon(Testing, testing)
  HelpIcon(Help, help)
  HelpIcon(Report, report)
  HelpIcon(Schedule, schedule)
  HelpIcon(Documentation, documentation)
}

@enduml

在上面的代碼中，我們先定義了一系列常量，包括圖標URL、大小和默認的背景顏色。然後我們定義了一些宏，例如PlantIcon、WorkPackageIcon、MarkIcon和HelpIcon。這些宏根據預定義的常量和任務名稱生成節點，節點用於表示任務或者工作包。在我們的示例中，我們定義了一個Mechanical Engineering任務，並在該任務下定義了各種工作包和任務。使用PlantUML，我們可以輕鬆地將所有定義組織成圖形，該圖形對於項目管理非常有用。

二、PlantUML語法

PlantUML的語法非常簡單，它使用文本標記和代碼生成圖形。在本節中，我們將介紹PlantUML常用的語法元素。

2.1 關鍵字

PlantUML包含一些關鍵字，這些關鍵字在文本中必須正確拼寫，才能正確生成圖形。下面是一些常用的關鍵字：

• node: 表示一個節點。
• component: 表示一個組件。
• database: 表示一個數據庫。
• actor: 表示一個操作者。
• interface: 表示一個接口。
• package: 表示一個包。
• class: 表示一個類。
• enum: 表示一個枚舉。
• usecase: 表示一個用例。

2.2 注釋

PlantUML支持兩種注釋：單行注釋和多行注釋。單行注釋用//標記，多行注釋用’和’

// 這是一個單行注釋
'
這是一個多行注釋
'

2.3 連接符

PlantUML使用連接符來指示關係。下面是一些常用的連接符：

• — : 表示雙向關係。
• –>: 表示單向關係。
• <|– : 表示繼承關係。
• .. : 表示聚合 / 組合關係。

2.4 樣式

PlantUML允許我們改變對象和關係的樣式，例如顏色、字體和邊框。下面是一些使用樣式的示例：

@startuml

!define ICONURL https://raw.githubusercontent.com/rabelenda/cicon-asset/main
!define ICONSIZE 64

node "Node Name" as Node {
  rectangle #CadetBlue {
    -- A
    -- B
    -- C
  }
}

Node : A --> (foo)
Node : B --> (bar)
Node : C --> (baz)

@enduml

2.5 變量

PlantUML支持變量，使得代碼更容易重用和維護。下面是一個使用變量的示例：

@startuml

!define TEXTCOLOR #000000
!define BORDERCOLOR #A0A0A0
!define FONTSIZE 14

skinparam class {
    BorderColor $BORDERCOLOR
    ArrowColor $BORDERCOLOR
    BackgroundColor White
    FontColor $TEXTCOLOR
    FontName Arial
    FontSize $FONTSIZE
}

class Foo {
    + method1()
    - method2()
}

Foo --|> Bar

@enduml

三、PlantUML流程圖

PlantUML的一個主要用途是繪製流程圖。下面是一個簡單的流程圖的示例：

@startuml

start
if (條件) then (yes)
  :相應操作;
else (no)
  :另一個操作;
endif
stop

@enduml

在上面的示例代碼中，start和stop都表示節點，if-then-else表示條件分支結構。如果條件為yes，則執行相應操作，否則執行另一個操作。

結語

PlantUML是一個功能強大的繪圖工具，它能夠輕鬆地繪製UML圖形和流程圖。本文詳細介紹了Plant3D教程、PlantUML語法和流程圖繪製。通過本文的學習，相信讀者對PlantUML有了更深入的了解，並能夠使用PlantUML繪製高質量的圖形。