Stilkonventionen für Code- und Textelemente

Diese Elemente identifizieren Codeoptionen und Variablen, die in der Hilfe-Dokumentation verwendet werden. Im Allgemeinen würden Sie diese Symbole oder Stilelemente nicht in Ihren Code- oder Datendateien aufnehmen. Sie sind nur visuelle Indikatoren.

Übereinkommen Erklärung

variable

Variablen werden in kursiv angezeigt. Ersetzen Sie den entsprechenden Wert für den Variablennamen.

Aus Gründen der Übersichtlichkeit werden manchmal Variablen und andere Codeelemente zwischen < > Klammern angezeigt. Sie müssen diese Symbole nicht in Ihrem Code verwenden.

[optional]

Elemente in eckigen Klammern sind optional.

(this|that)

Elemente in Klammern geben eine boolesche ODER Auswahl an.

literal

Fügen Sie Text oder Code genau wie gezeigt ein.

< >

Manchmal werden Variablen und andere Codeelemente zwischen < > Klammern angezeigt. Diese werden zur Verbesserung der Klarheit in langen Codeblöcken verwendet. Wenn nichts anderes angegeben ist, sollten Sie diese Symbole nicht in einen Datendateinamen oder dessen Inhalt aufnehmen.

Auf dieser Seite