Sdílet prostřednictvím

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

  • Článek

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ů rozhraní Microsoft .NET Framework, které lze předvést do funkce nebo skriptu. Můžete také zahrnout popis vstupních objektů.

.OUTPUTS

Typ rozhraní .NET Framework objektů, které rutina vrací. Můžete také zahrnout popis vrácených objektů.

.NOTES

Další informace o funkci nebo skriptu

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 řetězcem 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ě témat nápovědy pro funkci, skript, rutinu nebo poskytovatele.

.FORWARDHELPCATEGORY <Category>

Určuje kategorii nápovědy položky v .FORWARDHELPTARGETNAME. Pomocí tohoto klíčového slova se vyhnete konfliktům, pokud existují příkazy se stejným názvem.

Platné hodnoty jsou:

  • Alias
  • Rutina
  • HelpFile
  • Function
  • Provider
  • General
  • FAQ
  • Glossary
  • ScriptCommand
  • ExternalScript
  • Filtr
  • Všichni

.REMOTEHELPRUNSPACE <PSSession-variable>

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

.EXTERNALHELP <XML Help File>

Určuje cestu nebo název souboru nápovědy založeného na jazyce XML pro skript nebo funkci.

Klíčové slovo .EXTERNALHELP říká rutině Get-Help získat nápovědu pro skript nebo funkci v souboru založeném na jazyce XML. Při použití souboru nápovědy založeného na jazyce XML pro skript nebo funkci se vyžaduje klíčové slovo .EXTERNALHELP. Bez něj Get-Help nenajde soubor nápovědy pro funkci nebo skript.

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.

Při exportu funkce modulem skriptu by hodnota .EXTERNALHELP měla být název souboru bez cesty. Get-Help hledá soubor v podadresáři adresáře modulu specifickém pro národní prostředí. Pro název souboru nejsou žádné požadavky, ale osvědčeným postupem je použít následující formát názvu souboru: <ScriptModule>.psm1-help.xml.

Pokud funkce není přidružená k modulu, zadejte cestu a název souboru do hodnoty klíčového slova .EXTERNALHELP. Pokud zadaná cesta k souboru XML obsahuje podadresáře specifické pro ui-culture, Get-Help prohledává podadresáře rekurzivně pro soubor XML s názvem skriptu nebo funkce v souladu s jazykovými náhradními standardy stanovenými pro Windows, stejně jako to platí pro všechna témata nápovědy založená na jazyce XML.

Další informace o formátu souboru nápovědy xml nápovědy rutiny naleznete v tématu Psaní nápovědy k rutinám Prostředí Windows PowerShell.