tags:

views:

43

answers:

1

What symbol should I use ?

+4  A: 

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.

alt text

WileCau
thank you. But I think if there is a symbol which stands for comments in UML, there will be more convenient. Just like "//" in java, then I can write a comment after declaring a property or method.
Keating Wang
@Keating Wang, perhaps what you want is a Object Constraint Language comment? From http://www.omg.org/spec/OCL/2.2 section 7.4.10: "Comments in OCL are written following two successive dashes (minus signs). Everything immediately following the two dashes up to and including the end of line is part of the comment. For example: -- this is a comment"
WileCau