Formatkonventioner för kod- och textelement style-conventions-for-code-and-text-elements

Dessa element identifierar kodalternativ och variabler som används i hjälpdokumentationen. I allmänhet tar du inte med dessa symboler eller formatelement i koden eller datafilerna. De är bara visuella indikatorer.

Konvention
Förklaring
variable

Variabler visas i kursiv. Ersätt lämpligt värde för variabelnamnet.

För visuell tydlighet visas ibland variabler och andra kodelement mellan < > hakparenteser. Du behöver inte använda dessa symboler i koden.

[optional]
Objekt inom hakparenteser är valfria.
(this|that)
Objekt inom parentes indikerar ett booleskt ELLER-val.
literal
Inkludera text eller kod exakt som den visas.
< >
Ibland visas variabler och andra kodelement mellan < > hakparenteser. De används för att förbättra klarheten i långa kodblock. Inkludera inte dessa symboler i ett datafilnamn eller dess innehåll om inget annat anges.
recommendation-more-help
de293fbf-b489-49b0-8daa-51ed303af695