PlantUML中的注释语法到底是什么

最新推荐文章于 2025-10-02 01:16:00 发布
原创 最新推荐文章于 2025-10-02 01:16:00 发布 · 804 阅读 · 2 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#uml

引言

今天在使用VSCode的PlantUML插件的时候，突然想不起来注释的语法是什么了，求助了几个大模型，结果也不太对，记录一下正确答案，希望帮助到大家。

豆包和百度的回答

豆包和百度给出的回答就是使用常规的注释符号，实际测试了都不对，PlantUML不支持这样的语法。

知乎上的帖子怎么说

在知乎上搜到一个帖子（一文学会PlantUML(高效绘制UML图表) - 知乎），他是这么说的，也是不太对的。

DeepSeek怎么说

DeepSeek的情况好些，正确的错误的都有。

正确答案

PlantUML的文档中有正确答案：

不过它的中文文档不全，有的翻译了，有的没有，这段就没有。估计这是几个中文大模型表现不好的原因。 

结语

写这篇博客，一是做笔记，另外希望今后的大模型能够改进一下。

PlantUML语法官方参考手册中文版（最新版）
08-01
PlantUML官方参考手册中文版，详细。熟悉了语法，绘图会很方便。免去了拖拽的麻烦。。
PlantUml
womengmengyan的博客
05-25 7834
androidStudio安装插件：　一　）拆分解释一 顺序图：顺序图用 -> , –>, <-, <– 来绘制参与者（Participants）之 间的消息（Message）。 ( * ) –> Alice ：( * ) 表示起点 二 注释‘这是个单行注释/’这是个多行注释 ‘/三 参与者 actor Foo1 boundary Foo2 control Foo3 entity
PlantUML 完整教程：从入门到精通
最新发布
殇枫的博客
10-02 1252
PlantUML是一个开源工具，通过简单的文本描述快速生成各种UML图表（类图、时序图、用例图等）。其核心优势包括：纯文本格式便于版本控制、支持多种输出格式、跨平台运行，并能集成到开发环境和文档系统中。主要特点：1）文本驱动，语法简洁；2）支持时序图、活动图等14种图表类型；3）提供样式定制和主题功能；4）可与Markdown、Git等工具无缝协作。相比传统绘图工具，PlantUML更适合需要频繁更新和维护技术文档的开发团队，能显著提升文档编写效率和团队协作体验。
PlantUML
xnuscd的博客
12-03 2168
PlantUML 是一种简单的描述性语言，用于绘制各种 UML 图（如时序图、类图、活动图等）。它基于纯文本描述，生成图形化的 UML 图表。以下是 PlantUML 的基本语法简介，特别是时序图的语法。每个 PlantUML 脚本以@startuml开始，以@enduml结束。// 这是注释/* 注释内容 */actorACTOR。
使用 Sublime + PlantUML 高效地画图
axjrtdsdw37153372的博客
01-21 1680
什么是 PlantUML PlantUML 是一个画图脚本语言，用它可以快速地画出： 时序图 流程图 用例图 状态图 组件图 简单地讲，我们使用 visio 画图时需要一个一个图去画，但使用 PlantUML 只需要用文字表达出图的内容，然后就可以直接生成图片。看一个最简单的例子： Bob -> Alice : Hello, how are you Ali...
PlantUML语法（全）及使用教程-时序图
dmjxsy的博客
11-27 2万+
箭头上的文本对齐可以用 skinparam sequenceMessageAlign，后接参数left,right或center。skinparam responseMessageBelowArrow true命令，让响应信息显示在箭头下面。如果想用页码，则加上 %page% of %lastpage%关键字来定制参与者的显示顺序。关键字来定制参与者的颜色。
PlantUML语法（全）及使用教程-用例图
dmjxsy的博客
11-29 1万+
用例图是软件工程中的一种可视化表示方法，用于描述系统角色与系统本身之间的交互。它通过说明用例和与用例交互的角色来捕捉系统的动态行为。这些图表对于明确系统的功能要求和了解用户如何与系统交互至关重要。通过提供一个高层次的视图，用例图可以帮助利益相关者了解系统的功能及其潜在价值。 PlantUML通过其基于文本的语言，为创建用例图提供了一种独特的方法。使用 PlantUML 的主要优势之一就是简单高效。用户可以使用直观简洁的文字描述来定义图表，而不是手动绘制形状和连接。这不仅加快了图表创建过程，还确保了一致性和准
带有Java注释和PlantUML的活动图
linjingyg的博客
02-17 879
　　动机 　　文档很难-每个程序员都知道这是事实。 它也很无聊且重复，结果通常看起来很丑且难以阅读（因为并非所有程序员都是诗人）。 任何书面文档通常在完成之前就已经过时了，这并没有使它变得更好。 　　因此，编写文档通常是程序员应避免的事情。 　　最准确的文档是代码本身。 　　与程序员讨论文档时，您经常会听到一个简单的道理：最准确的文档是代码本身。 这是唯一不会过时，不会对您说谎并且永远完整的事情。 　　确实，编写良好的代码和测试对记录系统的目的非常有帮助。 特别是，通常遵循干净代码和域驱动...
PlantUML 语法、图标和示例
weixin_50367873的博客
07-23 2186
代码@startumltitle component定义组件@enduml图例。
PlantUML画类图(三)备注和模板
FantasyWxw的博客
04-28 9765
模板通过类关键字("<<“和”>>")来定义 可以使用note left of , note right of , note top of , note bottom of这些关键字来添加备注。 你还可以在类的声明末尾使用note left, note right,note top, note bottom来添加备注。 此外，单独用note这个关键字也是可以的，使用 … 符...
学习笔记之PlantUML
qq_21728931的博客
04-07 700
->可以绘制参与者之间的关系，虚线箭头可以使用-->；PlantUML是一款开源的UML图绘制工具，支持通过文本来生成图形，使用起来非常高效。可以支持时序图、类图、对象图、活动图、思维导图等图形的绘制。接下来，我们看看如何使用PlantUML插件绘制时序图、用例图、类图、活动图、思维导图等，以及它们的一些使用技巧。因为项目需要画一些时序图，因此今天给大家推荐一款画图工具PlantUML，可以配合IDEA使用，画图会更高效！这是一个简单的货物配送时序图，我们可以通过PlantUML提供的语法来生成。
UML类图（简介、类的表示、对象的表示、关系、注释）
Bulut0907
01-08 2万+
目录1. 简介2. 类和对象 1. 简介 UML（Unified Modeling Language）是一种面向对象的建模语言，包含我们所需要的所有图形标识；是一种更直观的图形方式，用符号来表示概念，概念间的关系用连接符合的线来表示 UML的各种图形，分别描述软件模型的静态结构、动态行为、模块组织和管理；本文我们讲解的类图（class diagram），是一种静态结构图（static structrue diagrams），用来描述类和对象、类和对象的内部结构、类和对象的关系 2. 类和对象 我们先来看一个
微知-plantuml常用语法和要点以及模板？（note over、create、box,endbox、alt,else,end, autonumber）
技术札记
11-20 3196
官网序列图： https://plantuml.com/sequence-diagram。使用 （nn） 选项（在箭头之前或之后）使箭头倾斜，其中 nn 是偏移像素的数量。关键字activate和deactivate用来表示参与者的生命活动。可以使用box和end box画一个盒子将参与者包裹起来。rnote代表正方形（rectangle）的备注框。还可以在box关键字之后添加标题或者背景颜色。destroy表示一个参与者的生命线的终结。一旦参与者被激活，它的生命线就会显示出来。更高级参考官网详细说明。
Plantuml之类图语法介绍(十六)
Android系统攻城狮
12-08 653
本篇目的：Plantuml之类图语法介绍PlantUML是一种开放源码的建模语言与工具，它可以帮助用户轻松地创建各种类型的UML图表，如时序图、用例图、类图、活动图等。该软件基于文本描述，用户可以使用简单的文本语法来描述图表的结构和关系，而无需手动绘制图形。这种基于文本的建模方法使得用户能够更专注于设计本身，而不是图形绘制的细节。PlantUML支持多种输出格式，包括PNG、SVG、PDF等，同时也支持集成到各种文档中，如Markdown、HTML、Word等。
PlantUML 之类图
热门推荐
文化园
06-21 2万+
类图介绍 今晚上借着燥热的天气学习下UML图的使用，然后开始连续3篇，时序图、活动图、类图的学习记录，为对项目开发中混沌的业务逻辑还以清晰. UML Sequence UML Class UML Activity 类图显示了系统的静态结构 类：类图中的主要元素，用矩形表示。矩形的上层表示类名、中层表示属性、下层表示方法。 类之间的关系：关联、依赖、聚集、泛化和实...
plantUML使用指南之序列图
十十办文武的博客
03-09 5664
在软件开发、系统设计和架构文档编写过程中，图形化建模工具扮演着重要的角色。而PlantUML作为一种强大且简洁的开源工具，深受开发者和架构师们的喜爱。通过使用简单的文本语法，PlantUML 能够将复杂的概念转化为直观而易于理解的图形表示，使得软件设计和沟通变得更加高效和便捷。本文旨在介绍和探索 PlantUML 的应用领域、语法规则和关键功能。我们将研究 PlantUML 的序列图，并通过实际案例和应用场景来展示其实际价值。
开源绘图工具plantUML入门教程（常用于画类图、时序图等）
pleaseprintf的博客
05-13 8345
随着工作时间的增长，越发觉得用专业的图形（用例图，时序图，ER图等等）去准确表达想法是很重要的。比如针对某个需求绘制的的用例图，比一段乏味的文字来的更加有意义，也便于别人理解。加之最近在学习源码的时候，发现很多书籍中都会使用类图，时序图等UML语言来描述逻辑关系。于是就在网上找了找绘制UML语言时，业界主流的一些工具都用什么，找了半天，大部分都用了下面的工具Visio，StartUML，PlantUML。最终经过比较选择了PlantUML。官网：https://plantuml.com/zh/
1 PlantUML 简介及语法、图标和示例
向阳的味道的博客
04-10 2万+
1.描述和安装程序员难免要经常画流程图，状态图，时序图等。以前经常用 visio 画，经常为矩形画多大，摆放在哪等问题费脑筋。有时候修改文字后，为了较好的显示效果不得不再去修改图形。今天介绍的工具是如何使用 PlantUML 的插件画流程图，状态图，时序图等。这是一种程序员看了就会爱上的画图方式：自然，高效。PlantUML是一个快速创建UML图形的组件，可在Eclipse、Intellijide...
PlantUML语法中怎么注释
07-31
<think>我们正在讨论PlantUML中的注释语法。根据引用[1]、[2]、[3]和[4]，PlantUML提供了多种注释方式，包括单行注释、多行注释以及在特定位置（如左侧、右侧、上方）添加注释。下面将详细说明如何添加注释。 ### PlantUML注释语法 #### 1. 单行注释 在元素旁边使用`note`关键字，后跟位置（如`left`, `right`, `over`）和注释内容。 - **在左侧添加注释**：`note left: 注释内容` - **在右侧添加注释**：`note right: 注释内容` - **在元素上方添加注释**：`note over: 注释内容` 示例（类图）： ```plantuml @startuml class 学生 { - 姓名: 字符串 + 学习() } note left of 学生 : 这是一个学生类 note over 学生 : 类注释 @enduml ``` #### 2. 多行注释 使用`note`和`end note`来包裹多行注释。 - 语法： ``` note left 第一行注释 第二行注释 end note ``` 示例（时序图）： ```plantuml @startuml Alice -> Bob: 你好！ note left of Alice 这是多行注释， 位于Alice左侧。 end note note over Bob: 单行注释 @enduml ``` #### 3. 在特定参与者或对象上添加注释 在时序图中，可以针对特定参与者添加注释： - `note left of [参与者]`: 在参与者左侧添加注释 - `note right of [参与者]`: 在参与者右侧添加注释 - `note over [参与者1], [参与者2]`: 跨越多个参与者的注释 示例（时序图）： ```plantuml @startuml participant Alice participant Bob Alice -> Bob: 消息 note left of Alice: Alice的注释 note right of Bob: Bob的注释 note over Alice, Bob: 共同注释 @enduml ``` #### 4. 注释形状和颜色（高级） 可以改变注释的形状和颜色： - 六边形注释：`hnote over [对象]` - 矩形注释：`rnote over [对象]` - 指定颜色：在注释后添加颜色代码，如`#FFAAAA` 示例： ```plantuml @startuml class 测试 { + 方法() } rnote over 测试 #LightBlue: 矩形注释 hnote over 测试 #Pink: 六边形注释 @enduml ``` ### 注意事项 - 注释位置关键字（`left`, `right`, `over`）后可以跟`of`指定具体对象。 - 注释内容中可以使用`\n`换行，但更推荐使用多行注释块。 - 在活动图、状态图等其他图中，注释语法类似。 ### 示例汇总 以下是一个综合示例（时序图）： ```plantuml @startuml autonumber participant 用户 participant 系统 用户 -> 系统: 登录请求 note left of 用户: 用户输入用户名和密码 系统 --> 用户: 登录成功 note over 系统: 验证通过 note right of 用户: 用户收到响应 @enduml ``` 通过以上方法，您可以在PlantUML图中灵活添加注释，增强可读性。 §§相关问题§§ 1. PlantUML中如何改变注释的颜色和形状？ 2. 在PlantUML时序图中如何为多个参与者添加同一个注释？ 3. PlantUML注释是否支持Markdown格式？</think>### PlantUML注释语法详解 在PlantUML中添加注释是增强图表可读性的重要手段，以下是完整的注释语法（基于您提供的引用内容）： #### 一、基础注释语法 1. **单行注释** 在元素旁边直接添加注释： ```plantuml class 用户 { +姓名: string +登录() } note left: 用户核心类 note right of 用户: 管理用户信息 ``` 2. **多行注释** 使用`note`和`end note`包裹多行内容： ```plantuml note left of 用户 这是多行注释示例： 1. 管理用户基本信息 2. 处理登录验证 end note ``` #### 二、位置控制语法 1. **相对位置注释** ```plantuml participant 客户端 participant 服务器 客户端 -> 服务器: 请求 note left: 客户端发起请求 // 左侧注释 note right: 服务器接收请求 // 右侧注释 ``` 2. **覆盖注释** 跨越多个元素： ```plantuml note over 客户端, 服务器: 网络通信过程 ``` 3. **元素关联注释** 精确关联到特定元素： ```plantuml class 数据库 note left of 数据库: MySQL存储 note right of 数据库: 端口3306 ``` #### 三、高级注释功能 1. **自定义注释样式** ```plantuml hnote over 服务器 #FFAAAA: 六边形注释 // 六边形 rnote over 客户端 #AAAAFF: 矩形注释 // 矩形 ``` 2. **带背景色的注释** ```plantuml note over 服务器 #LightBlue: 带背景色的注释 ``` 3. **对齐注释** 使用`/`对齐同级注释： ```plantuml note left of A 第一行 / 第二行 end note ``` #### 四、时序图中的注释示例 ```plantuml @startuml autonumber participant 用户 participant 系统 用户 -> 系统: 登录请求 note left: 用户输入凭证 系统 --> 用户: 验证结果 note right of 系统: 数据库校验 note over 用户, 系统 #LightGreen: 认证流程 @enduml ``` #### 五、活动图注释示例 ```plantuml @startuml start :初始化; note left #red: 重要初始化步骤 if (条件) then note over #Yellow: 条件分支 else endif stop @enduml ``` ### 关键注意事项 1. 注释位置关键字：`left`/`right`/`over`/`left of`/`right of` 2. 颜色语法：`#颜色码`紧接在位置关键字后 3. 多行注释必须使用`end note`闭合 4. 特殊注释符号： - `hnote` → 六边形注释 - `rnote` → 矩形注释 > 提示：在时序图中使用`autonumber`（如引用[3]所述）可自动生成步骤编号，配合注释更清晰[^3]。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

神一样的老师

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值