Neue Abschnitte

Sie können für Ihr Projekt neue Abschnitte anlegen.

Um einen neuen Abschnitt anzulegen:

Klicken Sie auf der Symbolleiste für den Schnellzugriff auf Settings .
Klicken Sie auf die Registerkarte General Settings.
Wählen Sie Sections aus.
In der Abschnittsliste klicken Sie auf die Schaltfläche Add.
Geben Sie in Name den Namen des Abschnittes ein, den Sie anlegen möchten. Der Name muss in Ihrem Projekt einzigartig sein.
Wählen Sie aus der Liste Type den Abschnittstyp aus.
Wählen Sie unter Options eine oder mehrere Einstellungen aus.
Geben Sie in XMLDoc die XMLDoc-Tags für Ihren Abschnitt, wenn Sie XMLDoc verwenden.
Geben Sie in Javadoc die Javadoc-Tags für Ihren Abschnitt ein, wenn Sie Javadoc verwenden.
Klicken Sie auf die Schaltfläche Ok. Der neue Abschnitt wird in der Abschnittsliste angezeigt.
Wählen Sie den neuen Abschnitt aus und geben Sie in Starters die Abschnittsbeginnzeichen für Ihren neuen Abschnitt ein.
Der Name des Abschnitts wird in der Ausgabe als Überschrift des Abschnittes angezeigt. Der Abschnittstyp, beeinflusst, wie der Abschnitt in der Ausgabe dargestellt wird und die interne Behandlung durch Doc-O-Matic.
Um einen Abschnitt zu Ihrem Kommentar einzufügen, geben Sie das Abschnittsbeginnzeichen als erste Zeichenkette in der Kommentarzeile ein.
Beachten Sie bitte: Wenn Sie den Editor benutzen, wird das erste eingetragene Abschnittsbeginnzeichen in den Sourcecode zurück geschrieben. Wenn Sie keinen Abschnittsbeginnzeichen angegeben haben, wird der Name des Abschnittes zurück geschrieben.

Abschnittstypen

Das ist eine Liste von Abschnittstypen, die Doc-O-Matic zur Verfügung stellt:

Abschnittstyp	Bedeutung
Standard	Text ohne spezielle Bedeutung.
Parameterbeschreibung	Text, der die Parameterbeschreibung enthält. Der Abschnitt kann als Liste von Parametern und Ihrer Beschreibung oder als zweispaltige Tabelle ausgegeben werden.
Rückgabebeschreibung	Text enthält die Beschreibung der Rückgabewerte.
Rückgabewerte	Text enthält die Beschreibung der Rückgabewerte. Der Abschnitt kann als Liste von Rückgabewerten und Ihrer Beschreibung oder als zweispaltige Tabelle ausgegeben werden.
Zusätzliche Information	Text enthält zusätzliche Informationen zum Thema. In diesem Abschnitt können Beispiele geben werden. Der Abschnitt wird in den Hilfesystemen zusätzlich auf einer eigenen Seite ausgegeben. Jeder Abschnitt kann individuell benannt werden, indem Sie eine Überschrift als erste Zeichenkette nach dem Abschnittsbeginnzeichen einfügen.
Zusammenfassung	Text enthält eine kurze Beschreibung des Zweckes des Symbols oder Elements. Dieser Abschnitt kann auch automatisch erzeugt werden.
Liste für Siehe auch	Text enthält entweder eine durch Beistriche getrennte Liste von Themen-IDs verwendet als Liste von verwandten Themen oder normalen Beschreibungstext. Die Themen-ID können auch jeweils in einer eigenen Zeile platziert werden. Der Abschnitt kann in den HTML-Hilfesystemen auf einer eigenen Seite dargestellt werden. Die Beistriche oder Absätze können für die Ausgabe ersetzt werden. (Option Output Replacing)
Ignorierte Text	Text, der von Doc-O-Matic ignoriert wird.
Glossartext	Text der nicht beim jeweiligen Thema ausgegeben wird, aber für Berichte und Glossare verwendet werden kann.
Implementierungsbeschreibung	Text in diesem Abschnitt wird als Beschreibung derImplementierung einer Funktion oder einer Datei verwendet.
Benannter Abschnitt	Dieser Abschnitt kann individuell benannt werden, indem der Name als erste Zeichenkette im Abschnitt durch einen Beistrich vom restlichen Text getrennt, geschrieben wird. Die Beistriche oder Absätze können für die Ausgabe ersetzt werden. (Option Output Replacing)
Werte-Liste	Text enthält eine Liste von Werten. Der Abschnitt kann als Liste von Werten und Ihrer Beschreibung oder als zweispaltige Tabelle ausgegeben werden.

Beachten Sie bitte: Die Abschnittstypen Memberbeschreibung, Themennavigation, Body-Source, Berichte, Themenlinks, Klassenhierarchie und Dateilinks werden von Doc-O-Matic dazu verwendet, um die entsprechenden Abschnitte automatisch zu erzeugen. Sie können diese Abschnitte umbenennen oder in der Wörterbuchdatei übersetzen. Abschnittstypen Syntax (Pascal, C++, VB.NET, C#, JavaScript, Java und IDL) werden von Doc-O-Matic verwendet, um die Deklaration der verwendeten Programmiersprache und die Übersetzung der Deklaration in andere Programmiersprachen anzuzeigen. Wenn Sie einen dieser Abschnitte in Ihrem Kommentar verwenden ersetzt der dort eingegebene Code und Text den automatisch hinzugefügten und übersetzten Code.

Überblick über zusätzliche Einstellungen

Option	Bedeutung
Automatische Hyperlinks	Schaltet die Erzeugung automatischer Hyperlinks für einen Abschnitt ein oder aus.
Zeilenvorschub entfernen	Lässt Doc-O-Matic Zeilenvorschübe entfernen. Wenn diese Option eingeschalten ist, verbindet Doc-O-Matic angrenzende Zeilen.
Leerzeichen entfernen	Lässt Doc-O-Matic unnötige Abstände entfernen. Wenn diese Option eingeschalten ist, verwandelt Doc-O-Matic eine Folge von Abständen in einen einzigen Abstand.
Linktext durch Text des Sprungziels ersetzen	Lässt Doc-O-Matic den Text der Hyperlinks durch den Titel des Themas zu dem die Hyperlinks erstellt wird ersetzen. Dies gilt für manuell hinzugefügte Hyperlinks ebenso wie für automatisch erzeugte. Wenn Sie zum Beispiel den Namen einer Funktion verwenden aber als Linktext möchten Sie das der gesamte Name des Symbols angezeigt wird (Klassenname::Funktionsname oder Klassenname.Funktionsname), können Sie diese Funktion für jeden Abschnitt einzeln aktivieren.
Text in neuer Zeile (nur im Editor)	Wenn ein Thema gespeichert wird, verwendet der Editor diese Option. Wenn sie eingeschalten ist, wird die Absatzüberschrift (Absatzbeginnzeichen) in eine eigene Zeile geschrieben. Wenn sie ausgeschalten ist, folgt der Abschnittstext dem Abschnittsbeginnzeichen in der gleichen Zeile getrennt durch einen Abschnittstrennzeichen.
Kürzen	Zusätzliche Abstände werden entfernt.
XMLDoc	XMLDoc Beginnzeichen. Sie müssen die Funktionalität XMLDoc eingeschalten haben, um XMLDoc verwenden zu können.
Javadoc	Javadoc Beginnzeichen. Sie müssen die Funktionalität Javadoc eingeschalten haben, um Javadoc verwenden zu können.

Verwandte Einstellungen

Abschnitte, Abschnittstrennzeichen, Übersetzungen und Wörter