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

于 2025-03-03 06:00:00 发布
阅读量372 收藏 2
点赞数 9
分类专栏： 使用技巧 文章标签： uml
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/bit_mike/article/details/145969005
版权

引言

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

豆包和百度的回答

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

知乎上的帖子怎么说

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

DeepSeek怎么说

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

正确答案

PlantUML的文档中有正确答案：

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

结语

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

PlantUML画类图(三)备注和模板
FantasyWxw的博客
04-28 9190
模板通过类关键字("<<“和”>>")来定义 可以使用note left of , note right of , note top of , note bottom of这些关键字来添加备注。 你还可以在类的声明末尾使用note left, note right,note top, note bottom来添加备注。 此外，单独用note这个关键字也是可以的，使用 … 符...
PlantUml
womengmengyan的博客
05-25 7675
androidStudio安装插件：　一　）拆分解释一 顺序图：顺序图用 -> , –>, <-, <– 来绘制参与者（Participants）之 间的消息（Message）。 ( * ) –> Alice ：( * ) 表示起点 二 注释‘这是个单行注释/’这是个多行注释 ‘/三 参与者 actor Foo1 boundary Foo2 control Foo3 entity
plantUML使用指南
loo_Charles_ool的博客
05-30 3251
platnuml使用介绍
PlantUML
xnuscd的博客
12-03 1461
PlantUML 是一种简单的描述性语言，用于绘制各种 UML 图（如时序图、类图、活动图等）。它基于纯文本描述，生成图形化的 UML 图表。以下是 PlantUML 的基本语法简介，特别是时序图的语法。每个 PlantUML 脚本以@startuml开始，以@enduml结束。// 这是注释/* 注释内容 */actorACTOR。
使用 Sublime + PlantUML 高效地画图
axjrtdsdw37153372的博客
01-21 1560
什么是 PlantUML PlantUML 是一个画图脚本语言，用它可以快速地画出： 时序图 流程图 用例图 状态图 组件图 简单地讲，我们使用 visio 画图时需要一个一个图去画，但使用 PlantUML 只需要用文字表达出图的内容，然后就可以直接生成图片。看一个最简单的例子： Bob -> Alice : Hello, how are you Ali...
PlantUML语法（全）及使用教程-用例图
dmjxsy的博客
11-29 7823
用例图是软件工程中的一种可视化表示方法，用于描述系统角色与系统本身之间的交互。它通过说明用例和与用例交互的角色来捕捉系统的动态行为。这些图表对于明确系统的功能要求和了解用户如何与系统交互至关重要。通过提供一个高层次的视图，用例图可以帮助利益相关者了解系统的功能及其潜在价值。 PlantUML通过其基于文本的语言，为创建用例图提供了一种独特的方法。使用 PlantUML 的主要优势之一就是简单高效。用户可以使用直观简洁的文字描述来定义图表，而不是手动绘制形状和连接。这不仅加快了图表创建过程，还确保了一致性和准
PlantUML语法官方参考手册中文版（最新版）
08-01
PlantUML是一种开源工具，它允许用户...随着用户对PlantUML语法的熟练运用，可以进一步探索其高级特性，如通过注释来隐藏或显示某些元素、为图形元素添加超链接、使用宏或包含文件等，以实现更加复杂的图形绘制需求。
PlantUML中文文档
05-16
9. **注释（Annotations）**：PlantUML支持在图表中添加注释，通过`note`关键字实现，可以指定注释的位置，如`right of`, `left of`, `top of`, 或 `bottom of`. 10. **自定义皮肤（Skin Parameters）**：用户可以...
PlantUML画类图添加备注和模板
02-07
在PlantUML中，我们可以使用如下的基本语法创建一个类： ```plantuml @startuml class MyClass { - myAttribute + myMethod() } @enduml ``` 在这个例子中，“MyClass”是类名，“myAttribute”是私有属性，...
PlantUML使用手册
03-10
在PlantUML中，单引号 `'` 开始的文本被视为注释。多行注释可以通过 `/` 开始，`/` 结束。 ```plantuml @startuml 'A simple single line comment /' This is a multiline comment /' @enduml ``` 1.3 定义参与者...
小书匠语法说明之plantuml1
08-04
plantuml 语法需要使用第三方服务器，系统默认指定小书匠自定义的服务器，内网用户可以通过设置中的服务器选项，修改成自己的 plantuml 服务器地址代码段内的文字将被encode成base64并被压缩后做为 :uml 内容提交到...
带有Java注释和PlantUML的活动图
linjingyg的博客
02-17 809
　　动机 　　文档很难-每个程序员都知道这是事实。 它也很无聊且重复，结果通常看起来很丑且难以阅读（因为并非所有程序员都是诗人）。 任何书面文档通常在完成之前就已经过时了，这并没有使它变得更好。 　　因此，编写文档通常是程序员应避免的事情。 　　最准确的文档是代码本身。 　　与程序员讨论文档时，您经常会听到一个简单的道理：最准确的文档是代码本身。 这是唯一不会过时，不会对您说谎并且永远完整的事情。 　　确实，编写良好的代码和测试对记录系统的目的非常有帮助。 特别是，通常遵循干净代码和域驱动...
PlantUML 语法、图标和示例
weixin_50367873的博客
07-23 1599
代码@startumltitle component定义组件@enduml图例。
PlantUML语法（全）及使用教程-时序图
dmjxsy的博客
11-27 1万+
箭头上的文本对齐可以用 skinparam sequenceMessageAlign，后接参数left,right或center。skinparam responseMessageBelowArrow true命令，让响应信息显示在箭头下面。如果想用页码，则加上 %page% of %lastpage%关键字来定制参与者的显示顺序。关键字来定制参与者的颜色。
学习笔记之PlantUML
qq_21728931的博客
04-07 568
->可以绘制参与者之间的关系，虚线箭头可以使用-->；PlantUML是一款开源的UML图绘制工具，支持通过文本来生成图形，使用起来非常高效。可以支持时序图、类图、对象图、活动图、思维导图等图形的绘制。接下来，我们看看如何使用PlantUML插件绘制时序图、用例图、类图、活动图、思维导图等，以及它们的一些使用技巧。因为项目需要画一些时序图，因此今天给大家推荐一款画图工具PlantUML，可以配合IDEA使用，画图会更高效！这是一个简单的货物配送时序图，我们可以通过PlantUML提供的语法来生成。
微知-plantuml常用语法和要点以及模板？（note over、create、box,endbox、alt,else,end, autonumber）
技术札记
11-20 2165
官网序列图： https://plantuml.com/sequence-diagram。使用 （nn） 选项（在箭头之前或之后）使箭头倾斜，其中 nn 是偏移像素的数量。关键字activate和deactivate用来表示参与者的生命活动。可以使用box和end box画一个盒子将参与者包裹起来。rnote代表正方形（rectangle）的备注框。还可以在box关键字之后添加标题或者背景颜色。destroy表示一个参与者的生命线的终结。一旦参与者被激活，它的生命线就会显示出来。更高级参考官网详细说明。
Plantuml之类图语法介绍(十六)
Android系统攻城狮
12-08 478
本篇目的：Plantuml之类图语法介绍PlantUML是一种开放源码的建模语言与工具，它可以帮助用户轻松地创建各种类型的UML图表，如时序图、用例图、类图、活动图等。该软件基于文本描述，用户可以使用简单的文本语法来描述图表的结构和关系，而无需手动绘制图形。这种基于文本的建模方法使得用户能够更专注于设计本身，而不是图形绘制的细节。PlantUML支持多种输出格式，包括PNG、SVG、PDF等，同时也支持集成到各种文档中，如Markdown、HTML、Word等。
PlantUML 之类图
热门推荐
文化园
06-21 2万+
类图介绍 今晚上借着燥热的天气学习下UML图的使用，然后开始连续3篇，时序图、活动图、类图的学习记录，为对项目开发中混沌的业务逻辑还以清晰. UML Sequence UML Class UML Activity 类图显示了系统的静态结构 类：类图中的主要元素，用矩形表示。矩形的上层表示类名、中层表示属性、下层表示方法。 类之间的关系：关联、依赖、聚集、泛化和实...
plantuml时序图语法
最新发布
12-28
### PlantUML 时序图语法教程 #### 创建基本时序图框架 要创建一个简单的时序图，需先定义参与者（participant）。这些代表对话中的实体，可以是人类角色或是软件组件。 ```plantuml @startuml participant Alice participant Bob @enduml ``` #### 添加消息传递路径 通过指定源和目标以及箭头方向，在两个参与者间建立通信连接。每条线表示一次调用或响应动作。 ```plantuml @startuml participant User participant "First Service" as FS participant "Second Service" as SS User -> FS : request() FS --> User : response() User -> SS : anotherRequest() SS --> User : anotherResponse() @enduml ``` #### 描述异步操作 对于非阻塞式的交互过程，则采用细虚线加开箭头的方式表达；而对于同步请求则保持实心闭合样式不变。 ```plantuml @startuml Alice -> Bob: asynchronous message ..> Bob : Another async msg @enduml ``` #### 表达自循环行为 当某个对象内部发生一系列连续活动而不涉及外部交流的时候，可以通过自我指向的消息实现这一点。 ```plantuml @startuml participant ComponentA ComponentA -> ComponentA : internal processing... @enduml ``` #### 注解与备注 为了增加可读性和解释复杂逻辑关系，可以在适当位置加入注释框作为补充说明。 ```plantuml @startuml participant Client participant Server Client -> Server : login(username, password) note right of Server : Verify credentials\nand generate token. Server --> Client : auth_token @enduml ``` #### 使用分组结构化展示阶段性的互动环节 借助`opt`, `alt/else`, `loop`等关键字构建条件分支或者重复执行片段，让整个流程更加直观易懂。 ```plantuml @startuml participant Customer participant PaymentGateway Customer -> PaymentGateway : pay(amount) alt sufficient funds PaymentGateway -> Customer : success else insufficient funds loop retry payment alt available balance increased PaymentGateway -> Customer : success else continue waiting PaymentGateway -> Customer : failure end end @enduml ```
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

神一样的老师

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

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

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

打赏作者

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

抵扣说明：

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

余额充值