Help op basis van opmerkingen in scripts plaatsen

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

Waar te plaatsen Comment-Based Help voor een script

• 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 scripttekst (na de Help) een functiedeclaratie is, moeten er ten minste twee lege regels zijn tussen het einde van de Help van het script en de functiedeclaratie. Anders wordt de Help geïnterpreteerd als Help voor de functie, niet als Help voor het script.

Voorbeelden van helpplaatsing in een script

In de volgende voorbeelden worden alle plaatsingsopties voor help op basis van opmerkingen voor een script weergegeven.

Help aan het begin van een script

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

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

param [string]$ComputerName
...

Hulp 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.
#>