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

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

摘要

文档是PlantUML语言参考指南（版本1.2023.11），介绍PlantUML作为快速绘制UML图的组件。支持多种UML图类型，包括序列图、用例图、类图、对象图、活动图、组件图、部署图、状态图和时序图。还支持非UML图如JSON数据、YAML数据、网络图、线框图、Archimate图、SDL、Ditaa图、甘特图、思维导图、工作分解结构图、数学公式和实体关系图。文档详细说明了各图类型的定义和语法，例如对象图使用object关键字定义对象实例，组件图使用component关键字或括号定义组件，状态图使用[*]表示起始和结束点。PlantUML提供简单直观的文本语言，方便用户快速创建和编辑图表，支持注释、Creole语法和样式控制命令。

AI总结

PlantUML 是一款通过纯文本快速绘制 UML 图的工具，支持序列图、用例图、类图、对象图、活动图、组件图、部署图、状态图、时序图，以及 JSON、YAML、网络图、线框图、思维导图等非 UML 图。其核心优势在于语法直观、文本与图形高度对应、易于编辑和集成。

**序列图**：使用 `->` 表示消息，`-->` 表示虚线消息，参与者无需提前声明。文本描述与最终图形高度一致，便于快速创建和修改。

**用例图**：用例用括号 `()` 定义，参与者用冒号 `:` 定义，均可使用 `as` 设置别名。文本定义方式避免了手动绘制，提升效率和准确性。

**对象图**：通过 `object` 关键字定义对象实例，使用 `<|--`（扩展）、`*--`（组合）、`o--`（聚合）等符号表示关系，可用 `..` 表示虚线，用双引号标注基数。

**组件图**：组件用方括号 `[]` 或 `component` 关键字定义，可使用 `as` 设置别名。注意以 `$` 开头的组件名需通过别名或标签才能被隐藏或移除。

**状态图**：使用 `[*]` 表示起始和终止状态，`-->` 表示箭头。可通过 `hide empty description` 将状态渲染为简单方框。

**通用命令**：支持单引号（`'`）和 C 风格块注释（`/' ' /`）。可添加标题、注释、控制大小和颜色，并支持 Creole 语法进行文本格式化、列表和超链接。

**高级功能**：支持将多个文件打包为 `.zip` 或 `.jar` 库，通过 `!import` 导入，再用 `!include` 引用。可通过 `-Dplantuml.include.path` 指定搜索路径，使用 `##` 语法实现宏参数拼接。