Megjegyzésalapú súgótémakörök elhelyezése szkriptekben

Ez a témakör azt ismerteti, hogy hol helyezhet el megjegyzésalapú súgót egy szkripthez, hogy a Get-Help parancsmag a megjegyzésalapú súgótémakört parancsfájlokkal társítsa, és ne a szkriptben esetleg szereplő függvényekhez.

A szkript Comment-Based súgójának helye

• A szkriptfájl elején.

  A szkript súgója csak megjegyzésekkel és üres sorokkal előzhető meg a szkriptben.

• A szkriptfájl végén.

  Ha a szkript törzsének első eleme (a súgó után) egy függvénydeklaráció, a szkript súgójának vége és a függvénydeklaráció között legalább két üres sornak kell lennie. Ellenkező esetben a függvény súgójaként értelmezi a súgót, nem pedig a szkript súgóját.

Példák a súgó elhelyezésére egy szkriptben

Az alábbi példák a szkriptek megjegyzésalapú súgójának elhelyezési lehetőségeit mutatják be.

Súgó a szkript elején

Az alábbi példában egy szkript elején található megjegyzésalapú szöveg látható.

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

param [string]$ComputerName
...

Súgó egy szkript végén

Az alábbi példában egy szkript végén található megjegyzésalapú szöveg látható.

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

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