Dokumentationserzeugung

Aus RAD Studio
Wechseln zu: Navigation, Suche

Nach oben zu Einführende Modellierungskonzepte


Die Funktion zum Erzeugen der Modellierungsdokumentation generiert automatisch die Dokumentation für Ihre UML-Modellierungsprojekte. Mit dieser Funktion illustrieren Sie Ihre Programme mit Dokumentationen im HTML-Format. Die erzeugte Dokumentation kann bei Änderungen im Projekt automatisch aktualisiert werden. Die Änderungen lassen sich aber auch nachträglich manuell in die Dokumentation einfügen.

Dokumentationsdateien

Alle erzeugten Dokumentationen werden in einem Dokumentationsverzeichnis abgelegt, das Sie im Dialogfeld Dokumentation generieren als Ausgabeordner festlegen. Erzeugte Dokumentationen werden standardmäßig in Ihrem Webbrowser geöffnet. Wenn Sie die Dokumentation nicht sofort laden möchten, können Sie dies später nachholen, indem Sie die Datei INDEX.HTML im angegebenen Dokumentationsverzeichnis öffnen.

Frames für die HTML-Dokumentation

Die HTML-Dokumentation enthält die folgenden Frames:

  • Den Diagramm-Frame, wenn die Option Diagramme einbeziehen aktiviert ist.
  • Die Projekt- und Übersichts-Frames, wenn die Option Navigationshierarchie einbeziehen aktiviert ist.
  • Die Package-Listen und Package-Übersichts-Frames werden links im Haupt-Frameset angezeigt, wenn die Option Navigationshierarchie einbeziehen deaktiviert ist.
  • Den Dokumentations-Frame.

Durch Klicken auf das Register Projekt können Sie die Knoten in der Projekt-Strukturansicht erweitern. Wenn Sie auf der Registerkarte Projekt auf einen Klassennamen klicken, wird die Dokumentation im Dokumentations-Frame geöffnet. Wenn Sie auf der Registerkarte Projekt ein Diagramm auswählen, wird es im Diagramm-Frame geöffnet. Die Elemente im Diagramm-Frame sind über Hyperlinks mit dem Dokumentations-Frame verknüpft. Wenn Sie ein Element im Diagramm-Frame auswählen, wird sein Inhalt im Dokumentations-Frame angezeigt.

Im Dokumentations-Frame wird die Dokumentation für Ihren Quelltext und Ihre Diagramme angezeigt. Der Frame enthält alle Komponenten, die Sie von einer HTML-Dokumentation erwarten. Am oberen Rand des Dokumentations-Frame befindet sich eine Navigationsleiste, mit der Sie in der Projektdokumentation blättern können.

Die Registerkarte Projekt enthält eine Strukturdarstellung des Projekts. Erweitern Sie die Knoten, um die verschiedenen Diagramme und Elemente anzuzeigen. Durch Klicken auf eine Klasse oder ein Interface öffnen Sie die entsprechende Dokumentation im Dokumentations-Frame.

Siehe auch