Convenzioni di stile per gli elementi di codice e testo

Questi elementi identificano le opzioni di codice e le variabili utilizzate nell'intera documentazione di aiuto. In genere, questi simboli o elementi di stile non vengono inclusi nel codice o nei file di dati. Sono solo indicatori visivi.

Convenzione Spiegazione

variable

Le variabili vengono visualizzate in corsivo. Sostituisci il valore appropriato per il nome della variabile.

Per chiarezza visiva, a volte le variabili e altri elementi di codice vengono visualizzati tra parentesi < >. Non è necessario utilizzare questi simboli nel codice.

[optional]

Gli elementi tra parentesi quadre sono facoltativi.

(this|that)

Gli elementi tra parentesi indicano una scelta booleana OR.

literal

Includi testo o codice esattamente come mostrato.

< >

A volte le variabili e altri elementi di codice compaiono tra < > parentesi. Vengono utilizzati per migliorare la chiarezza nei blocchi di codice lunghi. Se non specificato, non includere questi simboli nel nome o nel contenuto di un file di dati.

In questa pagina