Sie sind hier: Weitere Informationen > Spezielle Aufgaben
Spezielle Aufgaben
Technische Referenz
> Behandeln von Kommentaren > Beschreibung von Parametern und Rückgabewerten
Close
Doc-O-Matic 10
Beschreibung von Parametern und Rückgabewerten

Wenn Sie den Zweck einer Funktion beschreiben möchten, ist es oft nützlich den Zweck jedes einzelnen Parameters einzeln zu beschreiben. Doc-O-Matic unterstützt parameterweise Beschreibung im Parameter Abschnitt eines Themas und Rückgabewertebeschreibungen im Abschnitt Rückgabewert (Standardbeginnzeichen: Return Value List, Return Value Details). 

Zusätzlich können Sie die vordefinierten Variablen PAR0, PAR1, PAR2, PAR3 anstelle des Parameternamens verwenden. Die Variablen werden durch den Namen des n-ten Parameter ersetzt. Wenn Sie den Parameternamen in der Deklaration der Funktion ändern, werden die Namen der Parameter und Ihre Beschreibung automatisch angepasst.

Vermeiden Sie Zeichenformatierungen in Parameternamen und Rückgabewerten. Doc-O-Matic kann keine Zeichenformatierungen in Parameternamen und Rückgabewerten bearbeiten.

Es gibt verschieden Methoden wie und wo Sie Parameter beschreiben können:

Beschreibung der Parameter
Doc-O-Matic Option
Parameterbeschreibung nur mit dem Namen des Parameters
Parameterbeschreibung mit einer Syntax wie in der Deklaration beginnend mit dem Parameternamen
Erstes Wort
Parameterbeschreibung mit einer Syntax wie in der Deklaration endend mit dem Parameternamen
Letztes Wort
Parameterbeschreibung in Listen nach dem Parameter (die Beschreibung in Parameterlisten wird nur dann exportiert, wenn im gleichen Thema kein Abschnitt Parameter existiert)
Inline-Parameterlisten - Standardeinstellung

Beachten Sie bitte: Wenn Sie Erstes Wort und Letztes Wort benutzen, können Sie den Parameter immer noch auch nur mit seinem Namen verwenden.

Parameterbeschreibung, Kommentarstil, Abschnittstrennzeichen

Copyright © 2000-2020 toolsfactory software inc. Alle Rechte vorbehalten.