Sintassi della Guida basata sui commenti

In questa sezione viene descritta la sintassi della Guida basata su commenti.

Diagramma della sintassi

La sintassi per la Guida basata su commenti è la seguente:

# .< help keyword>
# <help content>

-o -

<#
.< help keyword>
< help content>
#>

Descrizione della sintassi

La Guida basata su commenti viene scritta come una serie di commenti. È possibile digitare un simbolo di commento (#) prima di ogni riga di commenti oppure è possibile usare i simboli <# e #> per creare un blocco di commenti. Tutte le righe all'interno del blocco di commenti vengono interpretate come commenti.

Ogni sezione della Guida basata su commenti è definita da una parola chiave e ogni parola chiave è preceduta da un punto (.). Le parole chiave possono essere visualizzate in qualsiasi ordine. I nomi delle parole chiave non fanno distinzione tra maiuscole e minuscole.

Un blocco di commenti deve contenere almeno una parola chiave della Guida. Alcune parole chiave, ad esempio .EXAMPLE, possono essere visualizzate più volte nello stesso blocco di commenti. 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 della Guida basata su commenti devono essere contigue. Se un argomento della Guida basato su commenti segue un commento che non fa parte dell'argomento della Guida, deve essere presente almeno una riga vuota tra l'ultima riga di commento non della Guida e l'inizio della Guida basata su commenti.

Ad esempio, l'argomento della Guida basata su commenti seguente contiene la parola chiave .DESCRIPTION e il relativo valore, ovvero una descrizione di una funzione o di uno script.

<#
    .DESCRIPTION
    The Get-Function function displays the name and syntax of all functions in the session.
#>