PlantUML 1.2021.1 Language Reference Guide

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

摘要

PlantUML 是一个用于快速生成多种 UML 图表以及其他类型图表的组件，支持包括类图、时序图、活动图、组件图、部署图、状态图、时间图等 UML 图表，以及 JSON 数据图、网络图、架构图、SDL 图、Ditaa 图、甘特图、思维导图等非 UML 图表。文档还介绍了预处理功能的迁移注意事项，包括变量定义、宏的使用等，并详细说明了如何使用标准库中的云服务图标，如 AWS、Azure 等。

AI总结

### 《PlantUML 1.2021.1语言参考指南》总结

#### 1. 概述
PlantUML 是一个功能强大的工具，用于快速生成多种类型的图表，包括：
- **UML图**：序列图、用例图、类图、对象图、活动图、组件图、部署图、状态图、时序图。
- **非UML图**：JSON数据图、网络图、图形界面设计、ArchiMate图、SDL图、Ditaa图、甘特图、思维导图、工作分解结构图、数学公式图、实体关系图。

PlantUML 使用简单直观的语言定义图表，支持多种自定义和扩展功能。

---

#### 2. 预处理功能
PlantUML 提供类似C语言预处理器的功能，但使用 `!` 替代了 `#`。主要特点包括：
- **变量定义**：支持整数和字符串变量，全局变量建议以 `$` 开头。

  !$ab = "foo1"
  !$cd = "foo2"
  !$ef = $ab + $cd

- **宏定义**：推荐使用 `!function` 和 `!procedure` 替代旧的 `!define` 和 `!definelong`。
- 旧宏（如 `!definelong`）需使用括号调用：`my_own_definelong()`。
- **包含文件**：`!include` 支持 URLs 和多次包含，替代旧的 `!include_many` 和 `!includeurl`。

---

#### 3. 标准库（stdlib）
PlantUML 提供丰富的标准库，支持多种技术和服务的图标和宏：
- **AWS 库**：用于绘制 AWS 架构图，包含 Amazon S3、Lambda、DynamoDB 等组件。

  !include 
  !include 

- **Azure 库**：提供微软 Azure 服务的图标和宏。

  !include 

- **CloudInsight 库**：用于表示流行技术的图标，支持可视化展示。

  !include 

- 其他库：包括 Kubernetes、Material Design、Office 等。

---

#### 4. 其他功能
- **Salt（盐）**：用于设计图形界面或网页原型。

  @startsalt
  { Login | "MyName " Password | "*****" [Cancel] | [ OK ] }
  @endsalt

- **ArchiMate**：支持架构设计图。

  @startuml
  Rel(personAlias, containerAlias, "Label", "Optional Technology")
  @enduml

- **数学公式**：支持 AsciiMath 或 JLaTeXMath。

  $a + $b = $c

---

#### 5. 示例（AWS 架构图）
以下是一个简单的 AWS 架构图示例：

@startuml
!include 
!include 

skinparam nodeBackgroundColor White
skinparam storage<**AmazonS3**> { backgroundColor #F9DFDC }

AMAZONS3(s3_internal, "Default S3")
AMAZONS3(s3_internal2, "S3 as node", node)
AMAZONS3_LARGE(s3_partner, "Large S3")

s3_internal2 <- s3_partner
s3_internal <- s3_partner
@enduml

---

#### 6. 总结
PlantUML 提供丰富功能，支持多种图表类型和自定义扩展，适合软件架构设计、文档编写和原型设计。通过预处理功能和标准库，用户可以高效地生成高质量图表。