Umieszczanie pomocy opartej na komentarzach w skryptach

W tym temacie wyjaśniono, gdzie umieścić pomoc opartą na komentarzach dla skryptu, aby polecenie cmdlet Get-Help kojarzyło temat pomocy opartej na komentarzach ze skryptami, a nie z żadnymi funkcjami, które mogą znajdować się w skrycie.

Gdzie umieścić Comment-Based Pomoc dla skryptu

• Na początku pliku skryptu.

  Pomoc skryptu może być poprzedzona tylko komentarzami i pustymi wierszami.

• Na końcu pliku skryptu.

  Jeśli pierwszy element w treści skryptu (po Pomocy) jest deklaracją funkcji, musi istnieć co najmniej dwa puste wiersze między końcem pomocy skryptu a deklaracją funkcji. W przeciwnym razie Pomoc jest interpretowana jako Pomoc dla funkcji, a nie Pomoc dla skryptu.

Przykłady umieszczania pomocy w skrycie

W poniższych przykładach pokazano każdą z opcji umieszczania dla pomocy opartej na komentarzach dla skryptu.

Pomoc na początku skryptu

Poniższy przykład przedstawia komentarz oparty na początku skryptu.

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

param [string]$ComputerName
...

Pomoc na końcu skryptu

Poniższy przykład przedstawia komentarz oparty na końcu skryptu.

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

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