Inserimento della Guida basata sui commenti negli script

In questo argomento viene illustrato dove inserire una Guida basata su commenti per uno script in modo che il cmdlet Get-Help associ l'argomento della Guida basata su commenti agli script e non a funzioni che potrebbero trovarsi nello script.

Posizione della Guida Comment-Based per uno script

• All'inizio del file di script.

  La Guida script può essere preceduta dallo script solo da commenti e righe vuote.

• Alla fine del file di script.

  Se il primo elemento nel corpo dello script (dopo la Guida) è una dichiarazione di funzione, devono essere presenti almeno due righe vuote tra la fine della Guida dello script e la dichiarazione di funzione. In caso contrario, la Guida viene interpretata come Guida per la funzione, non guida per lo script.

Esempi di posizionamento della Guida in uno script

Gli esempi seguenti illustrano ognuna delle opzioni di posizionamento per la Guida basata su commenti per uno script.

Guida all'inizio di uno script

Nell'esempio seguente viene illustrato il commento basato sull'inizio di uno script.

<#
.DESCRIPTION
This script performs a series of network connection tests.
#>

param [string]$ComputerName
...

Guida alla fine di uno script

Nell'esempio seguente viene illustrato il commento alla fine di uno script.

...
function Ping { Test-Connection -ComputerName $ComputerName }

<#
.DESCRIPTION
This script performs a series of network connection tests.
#>