Help op basis van opmerkingen in scripts plaatsen

In dit onderwerp wordt uitgelegd waar u hulp op basis van opmerkingen kunt plaatsen voor een script, zodat de Get-Help cmdlet het helponderwerp op basis van opmerkingen koppelt aan scripts en niet aan functies die zich in het script kunnen bevinden.

Waar Comment-Based Help voor een script plaatsen

• Aan het begin van het scriptbestand.

  Script Help kan alleen worden voorafgegaan door opmerkingen en lege regels in het script.

• Aan het einde van het scriptbestand.

  Als het eerste item in de hoofdtekst van het script (na de Help) een functiedeclaratie is, moet er ten minste twee lege regels zijn tussen het einde van het script Help en de functiedeclaratie. Anders wordt de Help geïnterpreteerd als Help voor de functie, niet Help voor het script.

Voorbeelden van Help-plaatsing in een script

In de volgende voorbeelden ziet u elk van de plaatsingsopties voor hulp op basis van opmerkingen voor een script.

Help aan het begin van een script

In het volgende voorbeeld ziet u een opmerking aan het begin van een script.

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

param [string]$ComputerName
...

Help aan het einde van een script

In het volgende voorbeeld ziet u opmerkingen aan het einde van een script.

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

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