PlantUML を使った UML の描き方 - PlantUML 言語リファレンスガイド(Version 1.2023.11)

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

摘要

文档是PlantUML 1.2023.11版本的语言参考指南，介绍如何使用PlantUML通过简单文本快速创建多种UML图（如序列图、用例图、类图、对象图、活动图、组件图、部署图、状态图、时序图）以及非UML图（如JSON数据、YAML数据、网络图、线框图、架构图、SDL、Ditaa、甘特图、思维导图、WBS图、数学符号、ER图）。文档详细说明了对象图的定义和关系表示，用例图的用例和参与者定义，组件图的组件声明和命名注意事项，以及部署图的元素声明。还介绍了自定义库的创建（!import和!include指令）、搜索路径设置（通过Java属性plantuml.include.path）和宏参数的字符串连接（##）。

AI总结

PlantUML 是一款通过文本描述快速绘制 UML 及多种图表的工具，支持序列图、用例图、类图、对象图、活动图、组件图、部署图、状态图、时序图，以及 JSON、YAML、网络图、线框图、甘特图、思维导图、ER 图等非 UML 图。

**核心功能与语法要点：**

- **对象图**：使用 `object` 定义实例，通过 `|--`、`*--`、`o--` 等符号表示扩展、组合、聚合关系，`..` 表示虚线，可用 `:` 添加关系标签。
- **用例图**：用例用圆括号 `( )` 定义，参与者用双冒号 `: :` 定义，均可使用 `as` 设置别名。
- **组件图**：组件用方括号 `[ ]` 或 `component` 关键字定义，支持别名。以 `$` 开头的组件名会被视为标签，需注意隐藏或删除时的处理。
- **部署图**：支持声明多种元素，如 actor、agent、artifact、database、node、cloud 等。
- **网络图 (nwdiag)**：支持定义网络、节点、云形状，使用 `--` 进行连接，支持分组和颜色设置。
- **自定义库与搜索路径**：可将多个文件打包为 `.zip` 或 `.jar`，通过 `!import` 导入，再用 `!include` 引用内部文件。搜索路径可通过 Java 属性 `plantuml.include.path` 指定。
- **宏与字符串拼接**：使用 `##` 可在宏参数后拼接字符串。
- **断言**：`!assert` 可用于条件检查，表达式为假时会输出错误信息并中断。