PlantUML 中的内联注释

Question

是否可以在PlantUML（Markdown 格式）中编写内嵌注释？

例如我想达到以下结果

@startuml
    participant Alice as A
    participant Bob as B

    A -> B    ' Here I would like to have my comment
    ...
@enduml

我知道可以使用以下符号：

' This is a comment on a single line
A -> B: Hello World
/' Multiple
comment
lines '/

我觉得奇怪的是这个风格：

participant Alice as A    /' Why does this comment work? '/

适用于参与者并且可以成功使用。只有参考文献才不起作用。

此处

提到的带有

'

和--符号的解决方案无法正常工作。

我已经检查了以下来源：

• https://forum.plantuml.net/1353/is-it-possible-to-comment-out-lines-of-diagram-syntax
• https://plantuml.com/de/commons

这里有可能吗？

Answer 1

根据最新规范，您可以通过三种方式在

*.puml

文件中添加注释部分：

1）简单评论

以简单引用开始的所有内容

'

都是评论。

@startuml
'Line comments use a single apostrophe
@enduml

2）屏蔽评论

块注释使用 C 风格注释，只不过您使用撇号

*

代替

'

，然后您还可以使用

/'

开始并使用

'/

结束将注释放在多行上。

@startuml
/'
many lines comments
here
'/
@enduml

3）将块注释放在同一行

@startuml
/' case 1 '/   A -> B : AB-First step 
               B -> C : BC-Second step
/' case 2 '/   D -> E : DE-Third step
@enduml

参考：QA-3906和QA-3910