Can I write comments in UML Class diagram?

Wha开发者_如何转开发t symbol should I use ?

---

Below is an extract from the Unified Modeling Language specification. The complete specification is available at http://www.omg.org/spec/UML/2.3.

9.5.1 Comment

A comment is a textual annotation that can be attached to a set of elements.

Description

A comment gives the ability to attach various remarks to elements. A comment carries no semantic force, but may contain information that is useful to a modeler. A comment may be owned by any element.

Notation

A Comment is shown as a rectangle with the upper right corner bent (this is also known as a “note symbol”). The rectangle contains the body of the Comment. The connection to each annotated element is shown by a separate dashed line.

Presentation Options

The dashed line connecting the note to the annotated element(s) may be suppressed if it is clear from the context, or not important in this diagram.

---

Use --.

...if you are looking to comment the UML source, rather than render a comment in a diagram. As mentioned by WileCau above the reference for this is here: http://www.omg.org/spec/OCL/2.2 and is called an Object Constraint Language comment."

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

This doesn't work in all UML renderers though - When I tried in PlantUML for example, it considered this a syntax error.

---

If you looking to add a comment in the UML source, depending on the renderer you can use -- or ' for a single line comment.

For PlantUML comments:

@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