Klíčová slova nápovědy pro Comment-Based

Toto téma obsahuje seznam a popisuje klíčová slova v nápovědě založené na komentářích.

Klíčová slova v nápovědě k Comment-Based

Níže jsou platná klíčová slova nápovědy založená na komentářích. Jsou uvedené v pořadí, ve kterém se obvykle zobrazují v tématu nápovědy spolu s zamýšleným použitím. Tato klíčová slova se můžou v nápovědě založené na komentářích zobrazovat v libovolném pořadí a nerozlišují se u nich velká a malá písmena.

Všimněte si, že klíčové slovo .EXTERNALHELP má přednost před všemi ostatními klíčovými slovy nápovědy založené na komentářích. Když je .EXTERNALHELP k dispozici, rutina Get-Help nezobrazuje nápovědu založenou na komentářích, ani když nemůže najít soubor nápovědy, který odpovídá hodnotě klíčového slova.

.SYNOPSIS

Stručný popis funkce nebo skriptu. Toto klíčové slovo lze použít pouze jednou v každém tématu.

.DESCRIPTION

Podrobný popis funkce nebo skriptu Toto klíčové slovo lze použít pouze jednou v každém tématu.

.PARAMETER <Parameter-Name>

Popis parametru. Do funkce nebo skriptu můžete zahrnout klíčové slovo .PARAMETER pro každý parametr.

Klíčová slova .PARAMETER mohou být v bloku komentáře zobrazena v libovolném pořadí, ale pořadí, ve kterém se parametry zobrazují v příkazu param nebo deklaraci funkce, určuje pořadí, ve kterém se parametry zobrazují v tématu nápovědy. Pokud chcete změnit pořadí parametrů v tématu nápovědy, změňte pořadí parametrů v příkazu param nebo deklaraci funkce.

Popis parametru můžete také zadat umístěním komentáře do příkazu param bezprostředně před název proměnné parametru. Pokud použijete komentář k příkazu param i klíčové slovo .PARAMETER, použije se popis přidružený k klíčovému slovu .PARAMETER a komentář k příkazu param bude ignorován.

.EXAMPLE

Ukázkový příkaz, který používá funkci nebo skript, volitelně následovaný ukázkovým výstupem a popisem. Opakujte toto klíčové slovo pro každý příklad.

.INPUTS

Typy objektů .NET, které lze předvést do funkce nebo skriptu. Můžete také zahrnout popis vstupních objektů. Toto klíčové slovo opakujte pro každý typ vstupu.

.OUTPUTS

Typ .NET objektů, které rutina vrací. Můžete také zahrnout popis vrácených objektů. Opakujte toto klíčové slovo pro každý typ výstupu.

.NOTES

Další informace o funkci nebo skriptu

.LINK

Název souvisejícího tématu. Toto klíčové slovo opakujte pro každé související téma. Tento obsah se zobrazí v části Související odkazy tématu nápovědy.

Obsah klíčového slova .LINK může také obsahovat identifikátor URI (Uniform Resource Identifier) do online verze stejného tématu nápovědy. Online verze se otevře, když použijete parametr OnlineGet-Help. Identifikátor URI musí začínat http nebo https.

.COMPONENT

Název technologie nebo funkce, kterou funkce nebo skript používá nebo ke které souvisí. Parametr ComponentGet-Help používá tuto hodnotu k filtrování výsledků hledání vrácených Get-Help.

.ROLE

Název role uživatele pro téma nápovědy. Parametr RoleGet-Help používá tuto hodnotu k filtrování výsledků hledání vrácených Get-Help.

.FUNCTIONALITY

Klíčová slova, která popisují zamýšlené použití funkce. Parametr FunctionalityGet-Help používá tuto hodnotu k filtrování výsledků hledání vrácených Get-Help.

.FORWARDHELPTARGETNAME <Command-Name>

Přesměruje se na téma nápovědy pro zadaný příkaz. Uživatele můžete přesměrovat na jakékoli téma nápovědy, včetně obsahu nápovědy pro funkci, skript, rutinu nebo poskytovatele.

# .FORWARDHELPTARGETNAME <Command-Name>

.FORWARDHELPCATEGORY

Určuje kategorii nápovědy položky v .FORWARDHELPTARGETNAME. Platné hodnoty jsou Alias, Cmdlet, HelpFile, Function, Provider, General, FAQ, Glossary, ScriptCommand, ExternalScript, Filternebo All. Pomocí tohoto klíčového slova se vyhnete konfliktům, pokud existují příkazy se stejným názvem.

# .FORWARDHELPCATEGORY <Category>

.REMOTEHELPRUNSPACE <PSSession-variable>

Určuje relaci, která obsahuje téma nápovědy. Zadejte proměnnou, která obsahuje objekt PSSession. Toto klíčové slovo používá rutina [Export-PSSession][09] k vyhledání obsahu nápovědy pro exportované příkazy.

# .REMOTEHELPRUNSPACE <PSSession-variable>

.EXTERNALHELP

Určuje soubor nápovědy založený na jazyce XML pro skript nebo funkci.

# .EXTERNALHELP <XML Help File>

Klíčové slovo .EXTERNALHELP je vyžadováno, pokud je funkce nebo skript zdokumentované v souborech XML. Bez tohoto klíčového slova Get-Help nemůže najít soubor nápovědy založený na jazyce XML pro funkci nebo skript.

Klíčové slovo .EXTERNALHELP má přednost před jinými klíčovými slovy nápovědy založené na komentářích. Pokud je .EXTERNALHELP k dispozici, Get-Help nezobrazuje nápovědu založenou na komentářích, i když nemůže najít téma nápovědy, které odpovídá hodnotě .EXTERNALHELP klíčového slova.

Pokud je funkce exportována modulem, nastavte hodnotu klíčového slova .EXTERNALHELP na název souboru bez cesty. Get-Help vyhledá zadaný název souboru v podadresáři konkrétního jazyka adresáře modulu. Pro název souboru nápovědy založeného na jazyce XML pro funkci nejsou žádné požadavky. Počínaje PowerShellem 5.0 je možné funkce exportované modulem zdokumentovat v souboru nápovědy, který je pojmenovaný pro modul. Klíčové slovo komentáře nemusíte používat .EXTERNALHELP . Pokud Test-Function je například funkce exportována modulem MyModule , můžete soubor nápovědy MyModule-help.xmlpojmenovat . Rutina Get-Help hledá nápovědu Test-FunctionMyModule-help.xml pro funkci v souboru v adresáři modulu.

Pokud funkce není součástí modulu, zahrňte cestu k souboru nápovědy založenému na JAZYCE XML. Pokud hodnota zahrnuje cestu a cesta obsahuje podadresáře specifické pro jazykovou kulturu uživatelského rozhraní, Get-Help rekurzivně hledá v podadresářích soubor XML, který má název skriptu nebo funkce, v souladu se standardy jazykové náhražky vytvořenými pro Windows, stejným způsobem jako v případě adresáře modulu.

Další informace o formátu souboru nápovědy XML pro rutiny naleznete v tématu Jak psát nápovědu pro rutiny.