Abschnitte

Um diese Seite zu öffnen: Klicken Sie auf der Registerkarte General Settings der Settings auf [General Settings] > Sections.

Standardeinstellung

Text am Anfang eines Kommentarblocks ohne Abschnittsbeginnzeichen, die eine Zuordnung zu einem bestimmten Abschnitt möglich macht, wird mit dem Standardabschnittstyp (Standardabschnitt) zugeordnet. Sie können jede beliebigen Abschnitt vom Typ Standard, Zusammenfassung oder Glossar zum Standardabschnitt machen.

Doc-O-Matic verwendet automatisch die Abschnittsnamen als Abschnittsbeginnzeichen, wenn Sie keine Zeichen in Starters für den erzeugten Abschnitt eintragen.

Abschnittstyp	Bedeutung
Standard	Text ohne spezielle Bedeutung.
Parameter Description	Text, der die Parameterbeschreibung enthält. Der Abschnitt kann als Liste von Parametern und Ihrer Beschreibung oder als zweispaltige Tabelle ausgegeben werden.
Return Description	Text enthält die Beschreibung der Rückgabewerte.
Return Values	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.
Additional 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.
Summary	Text enthält eine kurze Beschreibung des Zweckes des Symbols oder Elements. Dieser Abschnitt kann auch automatisch erzeugt werden.
See Also List	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.
Ignored Text	Text, der von Doc-O-Matic ignoriert wird.
Glossary Text	Text der nicht beim jeweiligen Thema ausgegeben wird, aber für Berichte und Glossare verwendet werden kann.
Implementation Description	Text in diesem Abschnitt wird als Beschreibung der Implementierung einer Funktion oder einer Datei verwendet.
Named Section	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.
Value Description List	Text enthält eine Liste von Werten. Der Abschnitt kann als Liste von Werten und Ihrer Beschreibung oder als zweispaltige Tabelle ausgegeben werden.

Um einen Abschnitt als Standardabschnitt zu verwenden

Wählen Sie in der Liste einen Abschnitt aus.
Klicken Sie auf Set Default.
Ein grünes Symbol neben dem Abschnittsnamen zeigt an, dass dieser Abschnitt als Standardabschnitt verwendet wird.

Hinweise

Die Abschnittstypen Memberbeschreibung, Themennavigation, Body-Source, Berichte, Überladungslisten, Themenlinks, Klassenhierarchie, Syntax und Symbol-Container werden von Doc-O-Matic dazu verwendet, um die entsprechenden Abschnitte automatisch zu erzeugen. Nur jeweils ein Abschnitt von diesen Typen wird von Doc-O-Matic für den jeweiligen Zweck verwendet. Wenn Sie einen weiteren Abschnitt von diesem Typ erzeugen, wird dieser nicht verwendet. Sie können diese Abschnitte wie jeden anderen Abschnitt umbenennen. Ändern Sie jedoch den Typ dieser Abschnitte nicht, da diese von Doc-O-Matic dann nicht mehr richtig verwendet werden können.

Glossar

sections Logische Teile, in die ein Kommentarblock oder ein Thema unterteilt werden kann.

starters Zeichen, die in Doc-O-Matic anzeigen, dass ein neuer Abschnitt beginnt.

default section Ein Abschnitt der in Doc-O-Matic für Text verwendet wird, der am Anfang eines Themas steht und der nicht mit Beginnzeichen anfängt.

predefined section In Doc-O-Matic Abschnitte, die in der Installation mitgeliefert werden.

user-defined sections In Doc-O-Matic Abschnitte, die der Benutzer in seinem Projekt anlegt.

automatically created sections In Doc-O-Matic Abschnitte, die Doc-O-Matic in der Ausgabe verwendet um bestimmten Inhalt zu präsentieren wie zum Beispiel Klassenhierarchien, Sourcecode und Überblickstabellen.

XMLDoc Ein Kommentarstil, der von C# und VB.NET-Compilern im .NET Plattform verarbeitet wird.

Javadoc Ein Kommentarstil, der von Java-Compilern verarbeitet wird.

Siehe auch

Themenaufbau, Neue Abschnitte, Anpassen von Abschnitten, Hinzufügen von Abschnitten, Zurückschreiben von Kommentaren, Wie sehen Abschnitte aus?, Abschnitte

Verwandte Einstellungen

Anzeige der Abschnitte, AutoDoc-Inhalt, Abschnittsoptionen