13.4. Das Register Dokumentation

Innerhalb des UML 1.4-Standards sind alle Modellelemente Subelemente der Metaklasse Element. Die Metaklasse Element definiert einen gekennzeichneten Wert Dokumentation für einen Kommentar, eine Beschreibung oder eine Erläuterung eines jeden Elementes. Da dieser gekennzeichnete Wert zu jedem Modellelement gehört, hat er sein eigenes Register im Bereich Details erhalten und nicht im Bereich Eigenschaftswerte.

Abbildung 13.7, „ Ein typisches Register Dokumentation im Bereich Details zeigt ein typisches Register Dokumentation für ein Modellelement in ArgoUML.

Abbildung 13.7. Ein typisches Register Dokumentation im Bereich Details

Ein typisches Register Dokumentation im Bereich Details

Wie Sie sehen können, wurden sehr viel mehr Felder dem Dokumentationsfeld hinzugefügt. Die anderen Felder speichern Ihre Informationen gewöhnlich unter Eigenschaftswerte: Autor, Version, Seit, Veraltet, Siehe.

Die Felder in diesem Register sind für alle Modellelemente die gleichen.

Da UML-Kommentare eine Art von Dokumentation sind, werden sie auch in diesem Register mit ihrem Namen und Erläuterungen angezeigt.

[Tipp]Tipp

ArgoUML ist primär kein Dokumentationssystem. Bei Modellelementen, die eine umfangreiche Dokumentation erfordern, zum Beispiel Anwendungsfälle, verwenden Sie das Feld Siehe:, um auf externe Dokumente zu verweisen. Dies ist praktischer.