Elemente kommentieren

Modellelemente können mit Kommentaren versehen werden, die insbesondere für deren Erläuterung gedacht sind.

Wesentliche Eigenschaften von Kommentaren

Kommentare sind ein Grundelement der UML, das für nahezu alle Modellelemente standardmäßig zur Verfügung steht.

Der Kommentar kann ohne Bezug zu einem bestimmten anderen Element im Modell stehen, oder er kann auf ein oder mehrere andere Elemente Bezug nehmen. Er besteht aus einem Text ohne vorgegebene semantische Bedeutung.

Kommentare sind

  • für nahezu alle Modellelemente möglich
  • ohne Einfluss auf die Semantik des Modells
  • unformatierter Text
  • auf kein, ein oder mehrere Modellelemente bezogen

Alle Kommentare innerhalb eines Diagramms können angezeigt oder ausgeblendet werden.

Kommentieren eines Elements

Zusammenhang

Sie können für nahezu jedes Modellelement Kommentare hinterlegen und später in die Dokumentation Ihres Modells einbinden.

Klicken Sie auf die Kommentarschablone in der Gruppe Diagramminhalte erzeugen und anschließend auf das zu kommentierende Modellelement im Diagramm oder auf das Diagramm selbst.

Alternativ selektieren Sie das oder die zu kommentierenden Elemente im Diagramm und klicken auf die Kommentarschablone.

Sie können einen Kommentar auch direkt in der Modellstruktur erstellen. Das selektierte Element wird kommentiertes Element und Besitzer des Kommentars.

Die Platzierung eines bestehenden Kommentars in einem Diagramm, das das kommentierte Element enthält, kann nachträglich erfolgen. Der Kommentar muss dazu auf eine freie Stelle im Diagramm gezogen werden.

Im Diagramm erfolgt die Texteingabe für den Kommentar direkt im Kommentarelement durch Umbenennen (F2). In der Modellelementliste ändern Sie den Kommentar im Eigenschaftenfenster. Sie können über die Zwischenablage Text in einen Kommentar übernehmen.

Kommentare können wie andere Modellelemente aus dem Diagramm entfernt oder aus dem Modell gelöscht werden.

So gehen Sie vor

  1. Klicken Sie auf die Kommentarschablone in der Gruppe Diagramminhalte erzeugen und anschließend auf das zu kommentierende Modellelement im Diagramm oder auf das Diagramm selbst.

    Der Kommentar wird im Diagramm platziert und über eine gepunktete Linie mit dem Element verknüpft. Der Standardtext des Kommentars wird zum Umbenennen selektiert.

  2. Geben Sie den Kommentar ein, verwenden Sie die [Eingabe]-Taste für Zeilenumbrüche und drücken Sie zum Abschluss [Strg]+[Eingabe] oder [Tab].

    Der Kommentar wird im Diagramm angezeigt.

Verknüpfen eines Kommentars mit einem Diagrammelement

Voraussetzungen

Geöffnetes Diagramm mit Kommentar und Diagrammelementen.

Zusammenhang

Sie können einen Kommentar nachträglich mit weiteren Diagrammelementen verknüpfen.

So gehen Sie vor

  1. Selektieren Sie den Kommentar, den Sie mit einem weiteren Element verknüpfen möchten.

  2. Ziehen Sie das Verknüpfungssymbol im Karussell auf das zu verknüpfende Diagrammelement.

    Der Kommentar ist mit dem Element verknüpft.

Lösen eines Kommentars von einem Diagrammelement

Zusammenhang

Sie können einen Kommentar von einem Diagrammelement lösen, indem Sie die Verknüpfung löschen.

So gehen Sie vor

  1. Selektieren Sie die Verknüpfung, die Sie lösen möchten.

  2. Wählen Sie Aus Modell löschen.

    Der Kommentar ist nicht mehr mit dem Element verknüpft.

Entfernen eines Kommentars aus einem Diagramm

Voraussetzungen

Geöffnetes Diagramm mit Kommentar und Diagrammelementen.

Zusammenhang

Sie können einen Kommentar aus einem Diagramm entfernen. Der Kommentar wird dadurch aus der Diagrammdarstellung entfernt, jedoch nicht aus dem Modell gelöscht.

Entfernte Kommentare können Sie wieder ins Diagramm einfügen, wobei die ursprünglichen Verknüpfungen automatisch wiederhergestellt werden.

So gehen Sie vor

  1. Selektieren Sie die Kommentare, die Sie aus dem Diagramm entfernen möchten.

  2. Wählen Sie Aus Diagramm entfernen.

    Die selektierten Kommentare werden aus dem Diagramm entfernt.

Einfügen eines bestehenden Kommentars in ein Diagramm

Zusammenhang

Sie können einen Kommentar, den Sie direkt in der Modellstruktur erstellt haben oder den Sie aus einem Diagramm entfernt haben, nachträglich in ein Diagramm, das das kommentierte Element enthält, einfügen. Der Kommentar muss dazu auf eine freie Stelle im Diagramm gezogen werden.

Für zuvor entfernte Kommentare werden dabei die ursprünglichen Verknüpfungen automatisch wiederhergestellt, wenn die kommentierten Elemente im Diagramm existieren.

So gehen Sie vor

  1. Ziehen Sie aus dem Toolfenster Modellelementliste einen Kommentar auf eine freie Stelle im Diagramm.

    Der Kommentar wird im Diagramm platziert. Ehemals verknüpfte Kommentare werden über eine gepunktete Linie erneut mit dem Diagrammelement verknüpft.

  2. Einen neu ins Diagramm eingefügten Kommentar verknüpfen Sie mit dem zu kommentierenden Diagrammelement (Sehen Sie hierfür: "Verknüpfen eines Kommentars mit einem Diagrammelement").