Themenaufbau

Doc-O-Matic unterteilt ein Thema in logische Teile, die Abschnitte genannt werden. Sie können diese Abschnitte verwenden, um unterschiedliche Aspekte eines Themas zu beschreiben. Ein Abschnitt wird durch einen eindeutigen Namen und eine Liste von Beginnzeichen durch die er im Thementext identifizierbar wird, definiert.

Wenn Sie Textteile in Ihrem Kommentarblock in einen anderen Abschnitt geben möchten, können Sie die mit Hilfe von Abschnittsbeginnzeichen machen.

Hinweise

Formatieren Sie die Abschnittsbeginnzeichen nicht fett oder unterstrichen, da Doc-O-Matic diese nicht mehr auffinden kann. Wenn Sie einen Abschnitt mehr als einmal pro Thema verwenden, wird der Abschnittstext zu einem großen Block zusammengefügt. Einzige Ausnahme sind Abschnitte vom Typ Zusätzliche Information.

Überblick über die vordefinierten Abschnitte

Die folgende Tabelle beschreibt den Zweck der Abschnitte:

Abschnitts Name	Typ	Zweck
Beschreibung	Standard	Enthält die Beschreibung des Themas.
Zusammenfassung	Zusammenfassung	Enthält eine Zusammenfassung der Themenbeschreibung.
Bemerkungen	Standard	Wird für ein oder mehrere kurze Anmerkungen zum Thema verwendet. Sollte kurz sein.
Anmerkungen	Standard	Für spezielle Bemerkungen zum Thema, kann recht lang sein.
Parameter	Parameterbeschreibung	Besteht aus einer Liste von Parameterbeschreibungen. Weitere Informationen über Parameterbeschreibungen finden Sie in Beschreiben von Parametern
Rückgabe	Rückgabebeschreibung	Enthält eine Beschreibung der Rückgabewerte einer Funktion.
Rückgabewerte	Rückgabewerte	Enthält eine Liste der Beschreibungen von Rückgabewerten.
Beispiele	Zusätzliche Information	Für Beispiele zum Thema das beschrieben wird.
Ignoriert	Ignorierter Text	Enthält Text, der in der erzeugten Dokumentation nicht aufscheint.
Siehe auch	Liste für Siehe auch	Enthält entweder eine durch Beistriche getrennte Liste von Themen-IDs, zu denen automatisch Hyperlinks erzeugt werden, oder normalen Text.
Fehler	Standard	Enthält eine Beschreibung der Fehler und Probleme des beschriebenen Objektes.
Intern	Standard	Enthält Dokumentationsteile, die nur den Teammitgliedern zugänglich sein sollten und nicht der Öffentlichkeit.
Todo	Standard	Enthält Text, der beschreibt, welche Teile des beschriebenen Objektes noch unvollständig sind und überarbeitet werden müssen.
Ausnahmen	Werte-Liste	Enthält eine Beschreibung von Exceptions, die von einer Funktion oder Methode während der Ausführung ausgegeben werden.
Bedingungen	Standard	Enthält eine Beschreibung über Vor- und Nachbedingungen bestimmter Elemente, zum Beispiel über Vorbedingungen über das Aufrufen von Funktionen.
Autor	Standard	Enthält Informationen über den Autor des Themas.
Geschichte	Standard	Enthält Informationen über die Entwicklung eines Elementes. Dies kann für jedes Thema verwendet werden, wird aber meistens für Dateien verwendet.
Version	Standard	Enthält Informationen über die Version eines bestimmten Elementes, wie die Versionsnummer und Kompatibilitätsnotizen für ältere Versionen.
Glossar	Glossartext	Enthält Text für Glossar Einträge für ein Thema. Dieser Abschnitt wird in der Ausgabe nicht beim jeweiligen Thema ausgegeben.
Sourcebeschreibung	Implementierungsbeschreibung	Enthält einen beschreibenden Text, der zur Implementierung eines Objektes hinzugefügt wird, wenn dieser in die Dokumentation integriert wird.
Mehrfach Glossar	Werte-Liste	Enthält Glossareinträge und deren Beschreibung. Beide Spalten können in einem Glossar (Bericht) ausgegeben werden. In der Standardeinstellungwird dieser Abschnitt nicht ausgegeben.
Linkliste	Benannter Abschnitt	Enthält Text oder Hyperlinks und einen Namen für den jeweiligen Abschnitt, als erste Zeichenkette, die vom folgenden Text durch einen Beistrich getrennt wird.

Für fortgeschrittene Benutzer

Doc-O-Matic kann automatisch Zusammenfassungen erzeugen. Diese Option kann auf der Seite Automatische Abschnitte eingeschalten werden.

Abschnitte können für Text, der nur bedingt erscheinen soll, verwendet werden. Wenn Sie verschiedene Dokumentationen von Ihrem Sourcecode erzeugen möchten, können Sie für die einzelnen Dokumentationen spezielle Abschnitte verwenden, wie zum Beispiel Firmenversion und den Export dieses Abschnittes für die normale Version verhindern. Weitere Informationen hierzu finden Sie in Wie kann ich unterschiedliche Dokumentationen von nur einem Source erzeugen?.

Weitere Information

Beispiel für Abschnittsbeginnzeichen
Beispiele für Abschnittsformatierung
Beispiel für Abschnitte

Siehe auch

Wie sehen Abschnitte aus?, Abschnitte, Abschnitte vom Typ Zusätzliche Information (Beispiele), Abschnitte Parameter, Rückgabewerte und Members, Abschnitte Siehe auch und benannte Abschnitte.