Textvariablen

Um diese Seite zu öffnen: Klicken Sie in den Settings auf der Registerkarte der entsprechenden Konfiguration auf AutoDoc > Variables

Standardeinstellung

Doc-O-Matic definiert folgende Variablen:

PROJECTTITLE: Der Projekttitel.
COPYRIGHT: Die Urheberrechtsinformation des Projektes.
PROJECTSUMMARY: Die Zusammefassung des Projektes.
AUTHOREMAIL: Die Emailadresse des Autors.
PROJECTVERSION: Die Versionsinformation des Projektes.
DATE: Das aktuelle Datum in kurzem Datumsformat.
DATEL: Das aktuelle Datum in langem Datumsformat.
TIME: Die aktuelle Zeit in kurzem Zeitformat.
TIMEL: Die aktuelle Zeit in langem Zeitformat.
USER: Der aktuelle Benutzername.
MACHINE: Der Name des Computers.
FILENAME: Der Name und der absolute Pfad der Datei, in der das Symbol enthalten ist.
LINENUMBER: Die Nummer der Zeile, in der sich das Symbol in der Sourcedatei befindet.
PAR0, PAR1, PAR2, PAR3: Wird durch den Namen des n-ten Parameters ersetzt, wenn das Thema eine Funktion beschreibt.
SYMBOLNAME: Wird durch den vollständigen Namen des Symbols ersetzt, wenn das Thema ein Symbol ist.
CLASSNAME: Wird durch den Namen der Klasse, in dem das Symbol deklariert ist ersetzt, wenn das Thema ein Mitglied oder eine Klasse ist.
MEMBERNAME: Wird durch den einfachen Namen des Symbols (Membername ohne Klassenname) ersetzt, wenn das Thema ein Mitglied ist.
NAMESPACE: Wird ersetzt durch den Namen des Namespaces.

Sie können die vordefinierten Variablen dazu verwenden, um Ihre eigenen Variablen zu erstellen.

Um eine Variable in Ihrer Dokumentation zu verwenden

Schalten Sie zum Editor um.
Geben Sie den Namen der Variable zwischen zwei Prozentzeichen ein

%USER%

Geben Sie in Value den Wert ein, durch den Sie die Variable ersetzen wollen ein.
Fügen Sie die Variable zu Ihrem Projekt hinzu.
Um die Variable zu formatieren, öffnen Sie das Dialogfeld Formatting. Die eingestellten Formatierungen werden auf alle Konfigurationen angewendet.
Die Variable wird zur Liste der Variablen des Editors hinzugefügt.

Hinweise

Beachten Sie bitte, dass Variablen nicht rekursiv aufgelöst werden.Variablen können nur in "Text" verwendet werden, Variablen in Abschnitten, die als <code> oder <pre> formatiert sind, oder Absätzen, die mit Vorformat oder Code formatiert sind, werden nicht aufgelöst. Sie können entweder vordefinierte Variablen verwenden oder Ihre eigenen Variablen erstellen.

Glossar

variable Ein Platzhalter für einen Wert der an einer anderen Stelle bestimmt wird.

Siehe auch

Verwenden von Variablen