Eingebettete Programmdokumentation
Dokumentieren Sie ein Programm und dessen Befehlszeilen-Schnittstelle mit eingebetteter Dokumentation.
Schlagwörter
- PROGRAM
-
Definiert den Start einer Programmdokumentation
- @short_description:
-
Definiert eine Kurzbeschreibung des Programms (optional).
- @synopsis:
-
Definiert die Argumente oder eine Liste von Argumenten, die das Programm akzeptiert (optional).
- @see_also:
-
Der Abschnitt »SEE ALSO« in den man-Pages (Unix-Handbuchseiten, optional).
- @arg:
-
Argument(e), die dem Programm übergeben wurden, und die zugehörige Beschreibung (optional).
- Description:
-
Eine ausführlichere Beschreibung des Programms.
- Returns:
-
Geben Sie an, welche Wert(e) das Programm zurück gibt (optional).
3.4.1. Beispiel einer Programmdokumentation.
Beispiel 3-12 Programm-Dokumentationsblock
/** * PROGRAM:test-program * @short_description: A test program * @synopsis: test-program [*OPTIONS*...] --arg1 *arg* *FILE* * @see_also: test(1) * @--arg1 *arg*: set arg1 to *arg* * @--arg2 *arg*: set arg2 to *arg* * @-v, --version: Print the version number * @-h, --help: Print the help message * * Long description of program. * * Returns: Zero on success, non-zero on failure */ int main(int argc, char *argv[]) { return 0; }