Articles

Sintassi dell’aiuto basato sui commenti

Posted on
  • 09/12/2016
  • 2 minuti per leggere
    • j
    • s
    • n

Questa sezione descrive la sintassi dell’aiuto basato sui commentibasato sui commenti.

Diagramma della sintassi

La sintassi dell’aiuto basato sui commenti è la seguente:

# .< help keyword># <help content>-or -<#.< help keyword>< help content>#>

Descrizione della sintassi

L’aiuto basato sui commenti è scritto come una serie di commenti. Puoi digitare un simbolo di commento (#) prima di ogni riga di commento, oppure puoi usare i simboli <# e #> per creare un blocco di commento. Tutte le linee all’interno del blocco di commento sono interpretate come commenti.

Ogni sezione della guida basata sui commenti è definita da una parola chiave e ogni parola chiave è preceduta da un punto (.). Le parole chiave possono apparire in qualsiasi ordine. I nomi delle parole chiave non sono case-sensitive.

Un blocco di commento deve contenere almeno una parola chiave di aiuto. Alcune delle parole chiave, come EXAMPLE, possono apparire più volte nello stesso blocco di commento. Il contenuto della Guida per ogni parola chiave inizia sulla riga dopo la parola chiave e può estendersi su più righe.

Tutte le righe di un argomento di Guida basato su commenti devono essere contigue. Se un argomento di aiuto basato su commenti segue un commento che non fa parte dell’argomento di aiuto, ci deve essere almeno una riga vuota tra l’ultima riga di commento non di aiuto e l’inizio dell’aiuto basato su commenti.

Lascia un commento

Il tuo indirizzo email non sarà pubblicato. I campi obbligatori sono contrassegnati *