Modellierung - Optionen für die Dokumentationserzeugung

Aus RAD Studio
Wechseln zu: Navigation, Suche

Nach oben zu Modellierungsoptionen

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

Hier wird mit (Ebene) angegeben, dass die Optionsseite Dokumentationserzeugung in den Zweigen Projekt, Projektgruppe und Vorgabe der Modellierungs-Optionshierarchie ausgewählt werden kann. (Siehe Hierarchische Ebenen der Modellierungsoptionen im Dialogfeld Modellierungsoptionen für weitere Informationen).


Mit den Optionen für die Dokumentationserzeugung wird eine Vielzahl an Inhalten überprüft, die in die erzeugte HTML-Dokumentation über die Diagramme aufgenommen oder ausgeschlossen werden soll. Damit wird auch festgelegt, wie die einbezogenen Elemente in die erzeugte Dokumentation angezeigt werden sollen.

Optionen für die Dokumentationserzeugung

Option Beschreibung und Vorgabewert

Unten

Legt den Text fest, der unten in jede generierte Dokumentationsdatei platziert werden soll.
Der Text wird am unteren Rand unter der unteren Navigationsleiste angezeigt.
Er kann HTML-Tags und Whitespaces enthalten.

Titel der Dokumentation

Legt den Titel fest, der oben in der generierten Ü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 in jede generierte Dokumentationsdatei platziert werden soll.
Die Fußzeile wird rechts neben der unteren Navigationsleiste angezeigt.
Sie kann HTML-Tags und Whitespaces enthalten.
Die Fußzeile wird erzeugt, wenn die Option Navigationsleiste, Kopf- und Fußzeile erzeugen True ist.

Kopfzeilentext

Legt den Kopfzeilentext fest, der in jede generierte Dokumentationsdatei platziert werden soll.
Die Kopfzeile wird rechts neben der oberen Navigationsleiste angezeigt.
Sie kann HTML-Tags und Whitespaces enthalten.
Die Kopfzeile wird erzeugt, wenn die Option Navigationsleiste, Kopf- und Fußzeile erzeugen True ist.

Navigationstyp

Definiert, wo Beschreibungen der Designelemente platziert werden sollen:

  • Package – In Package-Dateien.
  • Diagramm – In Diagrammdateien.

Der Vorgabewert ist Package.

Internen Browser verwenden

True – Verwendet zur Präsentation der Dokumentation einen internen Browser.
Der Vorgabewert ist False.

Fenstertitel

Legt den Titel fest, der in das HTML-Tag <title> in jede generierte Dokumentationsdatei aufgenommen werden soll.
Dieser Text wird im Fenstertitel und in allen Browser-Lesezeichen (Favoriten) angezeigt, die für diese Seite angelegt werden.
Der Titel darf keine HTML-Tags enthalten, da der Browser diese nicht korrekt interpretieren kann.


Optionen der Gruppe Einbeziehen

Option Beschreibung und Vorgabewert

internal (Package)

True – Nimmt interne Klassen (Packages in Designprojekten), Interfaces und Member in die erzeugte Dokumentation auf.
Der Vorgabewert ist True.

private

True – Zeigt in der erzeugten Dokumentation private Klassen, Interfaces und Member an.
Der Vorgabewert ist False.

protected

True – Zeigt in der erzeugten Dokumentation protected Klassen, Interfaces und Member an.
Der Vorgabewert ist False.

protected internal

True – Zeigt in der erzeugten Dokumentation protected internal Klassen, Interfaces und Member an.
Der Vorgabewert ist False.

public

True – Zeigt in der erzeugten Dokumentation public Klassen, Interfaces und Member an.
Der Vorgabewert ist False.


Optionen der Gruppe Navigation

Option 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 der Link Index in die Navigationsleisten oben und unten auf allen Seiten aufgenommen werden soll.
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

True – Erstellt für jede dokumentierte Klasse und jeden Namespace eine "Verwendungsseite". Diese Seite gibt an, welche Namespaces, Klassen, Methoden, Konstruktoren und Felder API-Elemente der gegebenen Klasse oder des Package verwenden.
Bei gegebener Klasse C würden in die Klasse C alle Unterklassen von C, Felder, die als C deklariert sind, Methoden, die C zurückgeben, und Methoden und Konstruktoren mit Parametern des Typs C eingeschlossen werden.
Der Vorgabewert ist False.


Siehe auch