Generieren von UML-Dokumentation

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

Startseite > 

Generieren von UML-Dokumentation

Altova Website: _ic_link UML-Projektdokumentation

 

Mit dem Befehl Projekt | Dokumentation generieren wird detaillierte Dokumentation zu Ihrem UML-Projekt in den Formaten HTML, Microsoft Word, RTF oder PDF generiert. Mit diesem Befehl generierte Dokumentation kann beliebig geändert und verwendet werden; Sie benötigen dazu keine Genehmigung von Altova.

 

Anmerkungen
Um Dokumentation im PDF-Format zu generieren oder die generierte Dokumentation anzupassen, muss Altova StyleVision (https://www.altova.com/de/stylevision) auf Ihrem Rechner installiert und lizenziert sein.
Um Dokumentation im Format MS Word zu generieren, muss MS Word (Version 2000 oder höher) installiert sein.

 

Die Dokumentation wird für die Modellierungselemente generiert, die Sie im Dialogfeld "Dokumentation generieren" ausgewählt haben. Sie können entweder das vordefinierte Design oder ein benutzerdefiniertes  StyleVision Power Stylesheet (SPS) für das Design verwenden. Bei Verwendung eines StyleVision Power Stylesheet können Sie die Ausgabe der generierten Dokumentation anpassen, siehe Anpassen der Ausgabe mit StyleVision.

 

Sie können auch einzelne Teile eines Projekts dokumentieren. Rechtsklicken Sie dazu in der Modellstruktur auf ein Element (bzw. mit Strg + Klick auf mehrere Elemente) und wählen Sie den Befehl Dokumentation generieren. Beim Element kann es sich um einen Ordner, eine Klasse, eine Schnittstelle, usw. handeln. Die Dokumentationsoptionen sind in beiden Fällen dieselben.

 

Miteinander in Beziehung stehende Elemente werden in der generierten Ausgabe durch Hyperlinks miteinander verbunden, sodass Sie von Komponente zu Komponente navigieren können. In der Dokumentation sind auch alle manuell erstellten Hyperlinks enthalten.

 

Wenn Ihr Projekt UModel-Profile (wie C#, Java, VB.NET, usw.) enthält, werden diese in die generierte Dokumentation inkludiert, wenn die Option Inkludierte Unterprojekte auf dem Register Inkludieren ausgewählt ist, siehe Optionen zur Generierung von Dokumentation.

 

So generieren Sie Dokumentation:

1.Öffnen Sie ein Projekt (z.B. C:\\Benutzer\<Benutzername>\Dokumente\Altova\UModel2019\UModelExamples\Bank_Java.ump).
2.Klicken Sie im Menü Projekt auf Dokumentation generieren.

um_docgen_01

3.Wählen Sie ein Ausgabeformat aus (HTML, Word, RTF, PDF).
4.Passen Sie optional die Generierungsoptionen an, siehe Optionen zur Generierung von Dokumentation.
5.Klicken Sie auf OK und wählen Sie einen Zielordner für die Ausgabe.

 

In den folgenden Abbildungen sehen Sie einen Ausschnitt aus einer UModel-Dokumentation mit vordefiniertem Design, die anhand der Projektdatei Bank_Java.ump generiert wurde.

um_docgen_02

Wie oben gezeigt, enthält die generierte Dokumentation im oberen Bereich der HTML-Datei einen Diagramm- und Elementindex (mit Links).

 

In der Abbildung unten sehen Sie einen Ausschnitt aus der generierten Dokumentation für die Klasse Account. Beachten Sie, dass die einzelnen Mitglieder in Klassendiagrammen auch mit Hyperlinks zu ihren Definitionen versehen sind. Wenn Sie z.B. auf eine Eigenschaft oder Operation klicken, gelangen Sie zu ihrer Definition. Auch die Hierarchieklassen sowie unterstrichener Text sind mit Hyperlinks versehen.

um_docgen_03


© 2019 Altova GmbH