Lägga till kommentarsbaserat hjälp i skript

Det här avsnittet beskriver var du placerar kommentarsbaserad hjälp för ett skript så att cmdleten Get-Help associerar det kommentarsbaserade hjälpavsnittet med skript och inte med funktioner som kan finnas i skriptet.

Var du kan placera Comment-Based hjälp för ett skript

• I början av skriptfilen.

  Skripthjälp kan endast föregås av kommentarer och tomma rader i skriptet.

• I slutet av skriptfilen.

  Om det första objektet i skripttexten (efter hjälpen) är en funktionsdeklaration måste det finnas minst två tomma rader mellan slutet av skripthjälpen och funktionsdeklarationen. Annars tolkas hjälpen som Hjälp för funktionen, inte Hjälp för skriptet.

Exempel på hjälpplacering i ett skript

I följande exempel visas var och en av placeringsalternativen för kommentarsbaserad hjälp för ett skript.

Hjälp i början av ett skript

I följande exempel visas kommentarsbaserad i början av ett skript.

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

param [string]$ComputerName
...

Hjälp i slutet av ett skript

I följande exempel visas kommentarsbaserad i slutet av ett skript.

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

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