Syntaxe nápovědy založené na komentářích

Tato část popisuje syntaxi nápovědy založené na komentářích.

Diagram syntaxe

Syntaxe nápovědy založené na komentářích je následující:

# .< help keyword>
# <help content>

nebo

<#
.< help keyword>
< help content>
#>

Popis syntaxe

Nápověda založená na komentářích je napsána jako řada komentářů. Před každý řádek komentářů můžete napsat symbol komentáře (#), nebo můžete k vytvoření bloku komentáře použít symboly <# a #>. Všechny řádky v bloku komentáře se interpretují jako komentáře.

Každá část nápovědy založené na komentářích je definována klíčovým slovem a každé klíčové slovo předchází tečka (.). Klíčová slova se můžou zobrazit v libovolném pořadí. V názvech klíčových slov se nerozlišuje malá a velká písmena.

Blok komentáře musí obsahovat alespoň jedno klíčové slovo nápovědy. Některá klíčová slova, například .EXAMPLE, se můžou objevit mnohokrát ve stejném bloku komentáře. Obsah nápovědy pro každé klíčové slovo začíná na řádku za klíčovým slovem a může obsahovat více řádků.

Všechny řádky v tématu nápovědy založené na komentářích musí být souvislé. Pokud se téma nápovědy založené na komentáři řídí komentářem, který není součástí tématu nápovědy, musí existovat alespoň jeden prázdný řádek mezi posledním řádkem komentáře bez nápovědy a začátkem nápovědy založené na komentáři.

Například následující téma nápovědy založené na komentářích obsahuje klíčové slovo .DESCRIPTION a jeho hodnotu, což je popis funkce nebo skriptu.

<#
    .DESCRIPTION
    The Get-Function function displays the name and syntax of all functions in the session.
#>