Dokumentieren von Elementen

www.altova.com Dieses Kapitel drucken Vorherige Seite Eine Ebene nach oben Nächste Seite

Startseite >  Anleitung zur Modellierung von... > Elemente >

Dokumentieren von Elementen

Sie können Dokumentationskommentare folgendermaßen zu Modellierungselementen hinzufügen:

 

Klicken Sie (entweder im Diagramm oder in der Modell-Struktur) auf das Element.
Geben Sie im Fenster "Dokumentation" Text ein.

 

Dokumentationstext wird zusammen mit dem Projekt gespeichert.

 

Wenn ein Element ausgewählt ist, wird die Dokumentation dazu, falls vorhanden, immer im Fenster "Dokumentation" angezeigt. Sie können Dokumentation auch als Kommentar im Diagramm anzeigen. Gehen Sie dazu folgendermaßen vor:

 

Klicken Sie mit der rechten Maustaste in das Diagramm und wählen Sie im Kontextmenü den Befehl Anzeigen | Anmerkende Kommentare.

 

Dokumentations-Hyperlinks

Um im Fenster "Dokumentation" einen Hyperlink zu erstellen, wählen Sie Text im Fenster aus, klicken Sie mit der rechten Maustaste darauf und wählen Sie im Kontextmenü den Befehl Hyperlinks einfügen/bearbeiten. Beim Ziel des Hyperlink kann es sich um eine Webseite, ein Diagramm, eine Datei oder ein anderes Element handeln, siehe auch Erstellen von Hyperlinks zu Elementen.

um_hyperlinks5

Fenster "Dokumentation"

 

Codegenerierung und Dokumentationskommentare

Wenn Sie anhand von Klassendiagrammen Code generieren, können alle auf Klassen und deren Mitglieder angewendete Kommentare (in Klassendiagrammen) ebenfalls in den generierten Code exportiert werden. Aktivieren Sie dazu vor der Generierung von Programmcode das Kontrollkästchen Dokumentation als JavaDocs schreiben (für Java) oder Dokumentation als DocComments verfassen (für C#, VB.NET), siehe auch Codegenerierungsoptionen.

 

Ebenso können Codekommentare auch beim Reverse Engineering von Programmcode zu einem Modell in das Modell importiert werden. Aktivieren Sie dazu vor dem Reverse Engineering das Kontrollkästchen JavaDocs als Dokumentation (für Java) oder DocComments als Dokumentation (für C#, VB.NET), siehe auch Optionen für den Code-Import.

 

Anmerkung:Beim Import von XML-Schemas wird nur die erste Annotation eines complex- oder simpleType im Fenster "Dokumentation" angezeigt.

 

Informationen zu den Entsprechungen der Kommentare in Programmcode (oder XML-Schemas) für UModel-Kommentare finden Sie in den Entsprechungstabellen zu den einzelnen Sprachen:

 

C#-Entsprechungen
VB.NET-Entsprechungen
Java-Entsprechungen
XML Schema-Entsprechungen

© 2019 Altova GmbH