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

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

摘要

文档是PlantUML 1.2023.11版本的语言参考指引。PlantUML是一个开源项目，支持快速绘制时序图、用例图、类图、对象图、活动图、组件图、部署图、状态图、定时图等UML图，以及JSON Data、YAML Data、网络图、线框图形界面、架构图、SDL、Ditaa图、甘特图、思维导图、工作分解结构图、数学公式、实体关系图等非UML图。文档详细介绍了类图元素声明和关系定义语法，对象图对象定义和关系符号，用例图的用例和角色定义，组件图组件和接口定义，以及部署图元素声明。此外还介绍了通过!import指令打包自定义库、通过java属性plantuml.include.path设置搜索路径、以及使用##语法进行宏参数拼接。文档还提到了PlantUML标准库，包含官方发布的文件资源，由社区贡献，可使用stdlib特殊图列出标准库文件夹。

AI总结

PlantUML 是一个开源项目，支持通过简单直观的文本语言快速绘制多种 UML 图（如时序图、用例图、类图、对象图、活动图、组件图、部署图、状态图、定时图）以及非 UML 图（如 JSON、YAML、网络图、线框图、架构图、SDL、Ditaa、甘特图、思维导图、WBS、数学公式、ER 图）。

文档主要介绍了以下核心功能：

- **自定义库与导入**：可以将多个文件打包成 `.zip` 或 `.jar` 文件，通过 `!import` 指令导入，然后使用 `!include` 引用其中的文件。
- **搜索路径**：可通过 Java 命令行参数 `-Dplantuml.include.path` 指定包含文件的搜索路径。
- **参数拼接**：使用 `##` 语法可以将文本追加到宏参数之后。
- **类图**：支持声明多种元素（如抽象类、类、接口、枚举等），并使用类似编程语言的语法定义类之间的关系。
- **对象图**：使用 `object` 关键字定义实例，并通过符号（如 `|--` 表示延伸，`*--` 表示组成）定义对象间的关系，支持添加标签和多重性。
- **用例图**：用例用圆括号定义，角色用双冒号定义，均可使用 `as` 设置别名。
- **组件图**：组件用中括号定义，接口用圆括号定义。注意，以 `$` 开头的组件名无法通过 `hide` 或 `remove` 命令隐藏/删除。
- **标准库**：官方标准库（stdlib）包含丰富的文件和资源，由社区贡献，可通过 `stdlib` 特殊图表列出其文件夹。