Modellierung - Optionen für die Dokumentationserzeugung

Nach oben zu Optionskategorien für die Modellierung - Index

Tools > Optionen > Modellierung > (Ebene) > Dokumentation generieren

Mit > (Ebene) > wird hier angegeben, dass die Quelltext-Optionsgruppe auf mehreren hierarchischen Ebenen der Modellierungskonfiguration ausgewählt werden kann. Die folgenden Modellierungskonfigurations-Ebenen können hier verwendet werden: Vorgabe, Projektgruppe und Projekt.

Mit den Optionen der Kategorie Dokumentation generieren wird der Inhalt (und dessen Darstellung) festgelegt, der in die erzeugte HTML-Dokumentation aufgenommen werden soll.

Die folgende Tabelle enthält die Optionen der Gruppe Allgemein:

Optionen	Beschreibung und Vorgabewert
Unten	Legt den Text fest, der unten in jeder Ausgabedatei platziert werden soll. Der Text wird am unteren Rand der Seite unter der unteren Navigationsleiste angezeigt. Er kann HTML-Tags und Whitespaces enthalten.
Titel der Dokumentation	Legt den Titel fest, der oben in der Übersichtsdatei angezeigt werden soll. Der Titel wird zentriert als Überschrift der Ebene 1 direkt unter der oberen Navigationsleiste angezeigt. Er kann HTML-Tags und Whitespaces enthalten.
Fußzeilentext	Legt den Fußzeilentext fest, der unten in jeder Ausgabedatei platziert werden soll. Die Fußzeile wird rechts neben der unteren Navigationsleiste angezeigt. Sie kann HTML-Tags und Whitespaces enthalten.
Kopfzeilentext	Legt den Kopfzeilentext fest, der oben in jeder Ausgabedatei platziert werden soll. Die Kopfzeile wird rechts neben der oberen Navigationsleiste angezeigt. Sie kann HTML-Tags und Whitespaces enthalten.
Navigationstyp	Legt die Position für Beschreibungen von Designelementen fest. Package: In Package-Dateien. Diagramm: In Diagrammdateien. Der Vorgabewert ist Package.
Internen Browser verwenden	Bei True wird für die Dokumentationspräsentation ein interner Browser verwendet. Der Vorgabewert ist False.
Fenstertitel	Legt den Titel fest, der in das HTML-Tag <title> aufgenommen werden soll. Dieser Text wird im Fenstertitel und in allen Browser-Lesezeichen (Favoriten) angezeigt, die für diese Seite angelegt werden. Dieser Titel sollte keine HTML-Tags enthalten.

Die folgende Tabelle enthält die Optionen der Gruppe Einbeziehen:

Optionen	Beschreibung und Vorgabewert
internal (Package)	Bei True werden in der erzeugten Dokumentation interne Klassen, Interfaces und Member angezeigt. Der Vorgabewert ist True.
Private	Bei True werden in der erzeugten Dokumentation 'private' Klassen, Interfaces und Member angezeigt. Der Vorgabewert ist False.
Protected	Bei True werden in der erzeugten Dokumentation 'protected' Klassen, Interfaces und Member angezeigt. Der Vorgabewert ist False.
protected internal	Bei True werden in der erzeugten Dokumentation 'protected internal' Klassen, Interfaces und Member angezeigt. Der Vorgabewert ist False.
Public	Bei True werden in der erzeugten Dokumentation 'public' Klassen, Interfaces und Member angezeigt. Der Vorgabewert ist True.

Die folgende Tabelle enthält die Optionen der Gruppe Navigation:

Optionen	Beschreibung und Vorgabewert
Hilfe generieren	Steuert, ob der Link HILFE in die Navigationsleisten oben und unten auf allen Seiten aufgenommen werden soll. Der Vorgabewert ist True.
Index erzeugen	Steuert, ob ein Index erzeugt wird. Der Vorgabewert ist True.
Navigationsleiste, Kopf- und Fußzeile erzeugen	Steuert, ob Navigationsleisten, Kopf- und Fußzeilen oben und unten auf allen erzeugten Seiten angezeigt werden. Der Vorgabewert ist True.
Hierarchie erzeugen	Steuert, ob eine Klassen/Interface-Hierarchie erzeugt wird. Der Vorgabewert ist True.
Verwendungsseite generieren	Bei True wird für jede dokumentierte Klasse und jeden Namespace eine "Verwendungsseite" erstellt. Diese Seite enthält Namespaces, Klassen, Methoden, Konstruktoren und Felder, die die gegebene Klasse oder den Namespace verwenden. Bei gegebener Klasse C wird bei Verwendung der C-Elemente Folgendes eingeschlossen: Unterklassen von C, Felder, die als C deklariert sind, Methoden, die C zurückgeben, und Methoden und Konstruktoren mit Parametern des Typs C. Der Vorgabewert ist False.

Siehe auch

• Konfigurieren der UML-Modellierung
• Konfigurationsebenen
• Optionswert-Editoren
• Systemmakros

• Modellierungsoptionen (Dialogfeld)
  • Modellierung - Diagrammoptionen (Erscheinungsbild)
  • Modellierung - Diagrammoptionen (Layout)
  • Modellierung - Diagrammoptionen (Drucken)
  • Modellierung - Diagrammoptionen (Ansichtsverwaltung)
  • Modellierung - Allgemeine Optionen
  • Modellierung - Optionen für die Modellansicht
  • Modellierung - Quelltextoptionen