我可以在UML类图中写注释吗？

Question

我应该使用什么符号？

Answer 1

以下是统一建模语言规范的摘录。完整的规范可在http://www.omg.org/spec/UML/2.3获得。

  

9.5.1评论

     

评论是一种文本注释   可以附加到一组元素。

     

<强>描述

     

评论提供了附加功能   对元素的各种评论。一条评论   没有语义力量，但可能   包含有用的信息   建模者。评论可能归自己所有   任何元素。

     

<强>符号

     

评论显示为带有的矩形   右上角弯曲（这是   也被称为“音符”。该   矩形包含的主体   评论。与每个人的联系   带注释的元素由a表示   单独的虚线。

     

演示文稿选项

     

连接音符的虚线   带注释的元素可以是   如果从中清楚就被压制了   背景，或在此不重要   图。

     

Answer 2

使用--。

...如果您要注释UML源，而不是在图中绘制注释。 As mentioned by WileCau above的参考信息在这里：http://www.omg.org/spec/OCL/2.2，被称为<对象约束语言注释。”

-- This section is about [etc.]
[My Thing] -> (Result)

这并不是在所有UML渲染器中都有效-例如，当我在PlantUML中尝试时，它认为这是语法错误。

Answer 3

如果您希望在UML源中添加注释，则可以根据渲染器使用--或'作为单行注释。

对于PlantUML评论：

@startuml
' This is a comment on a single line
Bob->Alice : hello
/' You quote alors use slash-and-quote
to split your comments on several
lines '/
@enduml