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

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

摘要

文档详细介绍了PlantUML工具的使用方法，包括支持的多种图表类型（如UML类图、序列图、组件图等）及其语法。文档还涵盖了如何使用预处理功能（如变量定义、函数和过程）、内置函数、日志记录以及如何包含外部文件和库。此外，文档介绍了如何使用AWS图标库创建带有AWS组件的图表，并提供了数学公式显示的支持。最后，文档讨论了PlantUML的高级功能，如类属性图标大小的调整和静态/抽象方法的定义。

AI总结

《PlantUML 语言参考指南》（版本 1.2020.23）是一份关于使用 PlantUML 绘制 UML 图和其他类型图表的文档。以下是文档的核心内容总结：

### 1. **PlantUML 功能概述**
PlantUML 是一个用于快速绘制多种图表的工具，支持以下类型的 UML 图：
- **UML 图**：类图、用例图、序列图、活动图、组件图、状态图、对象图、部署图、时序图。
- **非 UML 图**：JSON 数据图、图形界面设计图、Archimate 图、SDL 图、Ditaa 图、甘特图、思维导图、工作分解结构图、数学公式图。

### 2. **语法与简单示例**
PlantUML 使用简单直观的语言定义图表。例如：
- 类图：`class Example`
- 序列图：`Bob -> Alice: Hello`

文档还提供了更多语法细节，如文本对齐、箭头样式、颜色、编号等。

### 3. **自定义库与包含**
- **库的导入**：可以通过 `!import` 和 `!include` 指令将自定义库打包为 `.zip` 或 `.jar` 文件，并在图表中引用。
- **搜索路径**：通过 `plantuml.include.path` 属性指定包含文件的搜索路径。

### 4. **内置函数与日志**
- **内置函数**：提供了多种函数，如 `%date`（获取当前日期）、`%file_exists`（检查文件是否存在）、`%strpos`（查找子字符串）等。
- **日志功能**：使用 `!log` 指令输出调试信息，不会影响图表生成。

### 5. **预处理功能**
PlantUML 提供了类似 C 预处理器的功能，支持变量定义、函数和过程。需要注意的是，旧版本的预处理器指令（如 `!define`）已逐步弃用，建议使用新功能替代。

### 6. **标准库与扩展**
- **标准库**：官方标准库包含第三方贡献的内容，支持多种扩展包（如 AWS 图标库）。
- **AWS 库**：提供了亚马逊云服务（AWS）的图标和宏，支持通过 PlantUML 和 C4 模型生成 AWS 架构图。

### 7. **数学公式支持**
- **公式渲染**：支持通过 AsciiMath 或 JLaTeXMath 渲染数学公式。
- **依赖配置**：在 Java 11 及以上版本中，建议使用 GraalVM JavaScript 引擎以避免 Nashorn 引擎的警告。

### 8. **类图与高级功能**
- **类图属性**：支持定义类的字段和方法，包括静态和抽象修饰符。
- **属性图标**：通过 `skinparam classAttributeIconSize` 控制类属性图标的显示。

### 9. **总结**
PlantUML 是一个功能强大且灵活的工具，适用于多种类型的图表绘制。其语法简单直观，支持自定义库和扩展包，适合开发者和架构师用于文档编写和设计可视化。