Stilkonventionen für Code- und Textelemente

Letzte Aktualisierung: 2021-06-01
  • Themen:
  • Referenz
    Weitere Informationen zu diesem Thema

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

Übereinkommen Erklärung

variable

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

Für visuelle Klarheit werden manchmal Variablen und andere Code-Elemente 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 weisen auf eine boolesche ODER Auswahl hin.

literal

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

< >

Manchmal werden Variablen und andere Code-Elemente zwischen < > Klammern angezeigt. Diese werden verwendet, um die Klarheit in langen Codeblöcken zu verbessern. Wenn nichts anderes angegeben ist, dürfen Sie diese Symbole nicht in einen Datendateinamen oder dessen Inhalt aufnehmen.

Auf dieser Seite