Drawing UML with PlantUML - PlantUML Language Reference Guide(Version 1.2023.11)

• 语言: 英语
• 格式: .pdf
• 来源: pdf.plantuml.net

摘要

文档详细介绍了PlantUML 1.2023.11版本的语言参考，支持绘制多种UML图表，包括组件图、类图、活动图等，以及非UML图表如JSON、YAML、网络图和数学公式。组件图的定义和语法是重点，涉及命名规则和关系定义。数学公式可通过AsciiMath和JLaTeXMath表示。PlantUML整合了标准库和扩展，如C4模型和Cloud Insight sprites，以增强图表的可视化效果。

AI总结

《Drawing UML with PlantUML - PlantUML Language Reference Guide(Version 1.2023.11)》内容总结如下：

### 1. PlantUML 简介
PlantUML 是一种支持快速绘制多种 UML 图表和非 UML 图表的工具。其支持的 UML 图表包括：
- 顺序图（Sequence diagram）
- 用例图（Usecase diagram）
- 类图（Class diagram）
- 对象图（Object diagram）
- 活动图（Activity diagram）
- 组件图（Component diagram）
- 部署图（Deployment diagram）
- 状态图（State diagram）
- 定时图（Timing diagram）

非 UML 图表包括：
- JSON 数据
- YAML 数据
- 网络图（nwdiag）
- Wireframe 图形界面
- ArchiMate 图
- SDL（Specification and Description Language）
- Ditaa 图
- 甘特图（Gantt diagram）
- 思维导图（MindMap diagram）
- 工作分解结构图（Work Breakdown Structure diagram）
- 数学公式（使用 AsciiMath 或 JLaTeXMath 表示）
- 实体关系图（Entity Relationship diagram）

### 2. 组件图（Component Diagram）
- **定义**：组件图是 UML 的结构图，用于展示系统组件的组织和关系，帮助分解复杂系统并优化设计。
- **优势**：
- **简单性**：通过简单的文本描述快速创建组件图。
- **集成性**：与多种工具和平台无缝集成。
- **协作性**：PlantUML 论坛提供了讨论、分享和协作的平台。
- **语法**：
- 组件需使用方括号定义，或使用 `component` 关键字（若组件名不含空格或特殊字符可省略括号）。
- 使用 `as` 关键字定义别名，用于后续关系定义。
- 命名规则：以 `$` 开头的组件名需定义别名或添加标签，否则无法隐藏或删除。

### 3. 数学公式
PlantUML 支持使用 AsciiMath 和 JLaTeXMath 表示数学公式：
- **AsciiMath**：将 AsciiMath 表示转换为 LaTeX 表达式。
- **JLaTeXMath**：用于显示 LaTeX 格式的数学公式。
- 语法示例：

  @startmath
  f(t)=(a_0)/2 + sum_(n=1)^ooa_ncos((npit)/L)+sum_(n=1)^oo b_n\ sin((npit)/L)
  @endmath

  @startlatex
  \sum_{i=0}^{n-1} (a_i + b_i^2)
  @endlatex

### 4. 标准库（Standard Library）
- **概述**：PlantUML 标准库是官方发布的一部分，提供丰富的功能和资源，支持更高级的图表创建。
- **C4 库**：提供了 C4 模型相关的图表元素，支持从整体到细节的系统架构描述。
- **Cloud Insight 库**：包含 Cloud Insight 图标，用于直观展示流行技术的可视化表示。
- 使用方法：通过 `!include` 指令引入库文件。

### 5. 实体关系图（Entity Relationship Diagram）
- 基于信息工程符号扩展的类图功能。
- 语法与类图类似，但增加了信息工程关系和实体别名。
- 示例：

  entity Entity01 {
    * identifying_attribute -- * mandatory_attribute
    optional_attribute
  }

### 6. 其他功能
- **实体关系**：支持信息工程符号，如 `}|..||` 表示“一对多”关系。
- **数学公式**：支持通过 `@startmath` 和 `@endmath` 创建独立公式。
- **标准库示例**：通过 `stdlib` 指令查看标准库文件夹。
- **主框架**：支持在图表中添加主框架（mainframe）。

### 总结
PlantUML 是一款功能强大、语法简单且集成性强的图表工具，支持绘制多种 UML 和非 UML 图表。其标准库和扩展功能进一步提升了图表的丰富性和可视化效果，适合开发者和架构师使用。