UML Basic Architecture Modeling--General modeling technology of General mechanism (I.)



Modeling Comments

Annotation modeling

the most common purpose for which " ll use notes are to write down free-form observations, reviews, or explanations. By putting these comments directly in your models, your models can become a common repository for all the disparate Artifa CTS you " ll create during development. You can even use notes to visualize requirements and show how they tie explicitly to the parts of your model.

The most common purpose of using notes is to write down the free-form observations ﹑ comments or explanations. Placing annotations exactly in your model can make your model a common repository for all the different objects created during your development. You can even use notes to display requirements and show how they are explicitly associated with the part of the model.

To model a comment,

l put your Comment As text in a note and place it adjacent to the element to which it refers. You can show a more explicit relationship by connecting a note to its elements using a dependency relationship.

l remember That's can hide or make visible the elements of your model as you see fit. This means, you don " t has to make your comments visible everywhere the elements to which it's attached is visible. Rather, expose your comments in your diagrams only insofar as a need to communicate that information in that context.

l if your Comment is lengthy or involves something richer than plain text, consider putting your comment in an external document and Linking or embedding that document in a note attached to your model.

l as your model evolves, keep those comments that record significant decisions that cannot is inferred from the model it Self, and----unless they is of historic interest----discard the others.

　To model annotations,

l Put your comment as a piece of text in a note, and place it near the element it mentions. You can show a more explicit relationship by using the elements to connect to the notes with a dependency relationship.

l Remember that you can hide or show this element in your model according to your needs. It also means that you don't have to make your annotations ubiquitous, even though the elements it attaches to are visible. Instead, reveal your comments in your diagram only if you need to express the information in that context.

l If your comments are long or are more informative than plain text, consider placing your comments in an external document, linking or embedding that document in your notes and attaching it to your model.

l While your model is improving, keep notes that record significant decisions that cannot be inferred from the model unless they are interested in the history process, otherwise discard the other annotations.

For example, figure 6-9 shows a model that ' s a work in progress of a class hierarchy, showing some requirements that shape the model, as well as some notes from A design review.

As shown in Fig. 6-9, the work model for class-level enhancement is formed to represent a number of requirements, as well as some comments from the design review.

In this example, most of the comments is simple text (such as the "Note to Mary"), but one of the them (the note at the bottom of the diagram) provides a hyperlink to another document.

In this example, most of the comments are simple text (such as Mary's annotations), but one (the one at the bottom of the graph) provides a link to another document.

UML Basic Architecture Modeling--General modeling technology of General mechanism (I.)