使用 PlantUML 绘制 UML - PlantUML 语言参考指引(Version 1.2023.11)

• 语言: 中文（简体）
• 格式: .pdf
• 来源: pdf.plantuml.net

摘要

文档详细介绍了PlantUML的功能和语法，支持绘制多种UML图表，如时序图、用例图、类图、组件图、部署图等，并提供了文本定义的示例和操作指南。PlantUML通过简单直观的语言和语法，允许用户快速创建和编辑示意图，支持与多种工具和平台集成，并拥有活跃的社区支持。

AI总结

《使用 PlantUML 绘制 UML - PlantUML 语言参考指引(Version 1.2023.11)》总结如下：

---

### 1. **PlantUML 简介**
PlantUML 是一个开源工具，支持通过简单的文本语言快速绘制多种 UML 图和非 UML 图，包括时序图、用例图、类图、对象图、活动图、组件图、部署图、状态图、定时图等。此外，还支持 JSON、YAML、网络图、线框图形界面、甘特图、MindMap 等。PlantUML 通过直观的语法简化了图表创建流程，适合开发人员和非开发人员使用。

---

### 2. **PlantUML 的核心功能**
- **简单高效**：通过文本语言定义图表，避免复杂的 GUI 工具，快速创建和迭代。
- **多平台集成**：支持多种输出格式，能无缝集成到各种文档和开发平台。
- **社区支持**：PlantUML 社区活跃，提供丰富的资源和帮助，用户可以在论坛上讨论、分享和协作。

---

### 3. **主要图表类型及语法**
#### 3.1 **对象图**
- 对象用 `object` 关键字定义，支持别名。
- 关系符号：`<|--`（继承）、`*--`（组成）、`o--`（聚合），虚线用 `..` 代替 `--`。
- 支持添加标签和基数（如 ` cardinality`）。

示例：

object Object01
Object01 <|-- Object02
Object03 *-- Object04

#### 3.2 **用例图**
- 用例用圆括号或 `usecase` 关键字定义，支持别名。
- 角色用冒号或 `actor` 关键字定义，支持别名。

示例：

(First usecase)
:First Actor:
actor Woman3

#### 3.3 **类图**
- 类图支持定义类、接口、枚举、注解等。
- 使用 `hide/show` 命令控制显示内容，如隐藏空属性或方法。

示例：

class ArrayList {
  Object[] elementData
  {method} size()
}
enum TimeUnit { DAYS, HOURS, MINUTES }
annotation SuppressWarnings

#### 3.4 **活动图**
- 支持新语法，提供直观的活动流定义。

#### 3.5 **组件图**
- 组件用中括号或 `component` 关键字定义，支持别名。
- 接口用圆括号定义。

示例：

[First component]
component Comp3
() as Interface1

#### 3.6 **部署图**
- 支持定义节点、云、数据库、文件等部署元素。
- 简洁的语法用于描述部署架构。

示例：

actor actor
node "Node1"
cloud "Cloud1"
database "Database1"

---

### 4. **扩展功能**
- **数学公式**：支持通过 AsciiMath 和 JLaTeXMath 插入数学公式，适合技术文档。

示例：

  :int_0^1 f(x)dx
  \dfrac{d}{dx}f(x)=\lim\limits_{h \to 0}\dfrac{f(x+h)-f(x)}{h}

- **非 UML 图**：支持甘特图、MindMap、WBS、网络图等。

---

### 5. **PlantUML 的优势**
- **开源且免费**：无许可限制，适合个人和企业使用。
- **社区驱动**：活跃的社区提供技术支持和资源共享。
- **灵活性**：支持多种图表类型，满足不同需求。

---

### 总结
PlantUML 是一款功能强大、易于使用的工具，适合快速创建 UML 和非 UML 图表。其简单的语法、丰富的功能和强大的社区支持使其成为开发人员和非开发人员的理想选择。