Sdílet prostřednictvím

Vložení nápovědy založené na komentářích do skriptů

  • Článek

Toto téma vysvětluje, kam umístit nápovědu založenou na komentářích pro skript, aby rutina Get-Help přidružila téma nápovědy založené na komentářích ke skriptům a ne k žádným funkcím, které by mohly být ve skriptu.

Kde umístit Comment-Based nápovědu pro skript

  • Na začátku souboru skriptu.

    Nápovědu ke skriptu můžou předcházet jenom komentáře a prázdné řádky.

  • Na konci souboru skriptu.

    Pokud první položka v těle skriptu (za nápovědou) je deklarace funkce, musí existovat alespoň dva prázdné řádky mezi koncem nápovědy skriptu a deklarací funkce. Jinak se nápověda interpretuje jako nápověda pro funkci, nikoli jako nápověda pro skript.

Příklady umístění nápovědy ve skriptu

Následující příklady ukazují jednotlivé možnosti umístění nápovědy pro skript založený na komentářích.

Nápověda na začátku skriptu

Následující příklad ukazuje komentář založený na začátku skriptu.

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

param [string]$ComputerName
...

Nápověda na konci skriptu

Následující příklad ukazuje komentář založený na konci skriptu.

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

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