Comment-Based hjälpnyckelord

Det här avsnittet visar och beskriver nyckelorden i kommentarsbaserad hjälp.

Nyckelord i hjälpen för Comment-Based

Följande är giltiga kommentarsbaserade hjälpnyckelord. De visas i den ordning de vanligtvis visas i ett hjälpavsnitt tillsammans med deras avsedda användning. Dessa nyckelord kan visas i valfri ordning i den kommentarsbaserade hjälpen och de är inte skiftlägeskänsliga.

Observera att nyckelordet .EXTERNALHELP har företräde framför alla andra kommentarsbaserade hjälpnyckelord. När .EXTERNALHELP finns visar cmdleten Get-Help inte kommentarsbaserad hjälp, även om den inte kan hitta en hjälpfil som matchar nyckelordets värde.

.SYNOPSIS

En kort beskrivning av funktionen eller skriptet. Det här nyckelordet kan bara användas en gång i varje ämne.

.DESCRIPTION

En detaljerad beskrivning av funktionen eller skriptet. Det här nyckelordet kan bara användas en gång i varje ämne.

.PARAMETER <Parameter-Name>

Beskrivningen av en parameter. Du kan inkludera ett .PARAMETER nyckelord för varje parameter i funktionen eller skriptet.

Nyckelorden .PARAMETER kan visas i valfri ordning i kommentarsblocket, men i vilken ordning parametrarna visas i param-instruktionen eller funktionsdeklarationen avgör i vilken ordning parametrarna visas i hjälpavsnittet. Om du vill ändra ordningen på parametrarna i hjälpavsnittet ändrar du ordningen på parametrarna i param-instruktionen eller funktionsdeklarationen.

Du kan också ange en parameterbeskrivning genom att placera en kommentar i param-instruktionen omedelbart före parametervariabelnamnet. Om du använder både en param-instruktionskommentare och ett .PARAMETER nyckelord används beskrivningen som är associerad med nyckelordet .PARAMETER och kommentaren för param-instruktion ignoreras.

.EXAMPLE

Ett exempelkommando som använder funktionen eller skriptet, eventuellt följt av exempelutdata och en beskrivning. Upprepa det här nyckelordet för varje exempel.

.INPUTS

.NET-typerna av objekt som kan skickas till funktionen eller skriptet. Du kan också ta med en beskrivning av indataobjekten. Upprepa det här nyckelordet för varje indatatyp.

.OUTPUTS

.NET-typen för de objekt som cmdleten returnerar. Du kan också ta med en beskrivning av de returnerade objekten. Upprepa det här nyckelordet för varje utdatatyp.

.NOTES

Ytterligare information om funktionen eller skriptet.

.LINK

Namnet på ett relaterat ämne. Upprepa det här nyckelordet för varje relaterat ämne. Det här innehållet visas i avsnittet Relaterade länkar i hjälpavsnittet.

Det .LINK nyckelordsinnehållet kan också innehålla en URI (Uniform Resource Identifier) till en onlineversion av samma hjälpavsnitt. Onlineversionen öppnas när du använder parametern Online för Get-Help. URI:n måste börja med http eller https.

.COMPONENT

Namnet på den teknik eller funktion som funktionen eller skriptet använder, eller till vilken den är relaterad. Parametern Component för Get-Help använder det här värdet för att filtrera sökresultaten som returneras av Get-Help.

.ROLE

Namnet på användarrollen för hjälpavsnittet. Parametern Role för Get-Help använder det här värdet för att filtrera sökresultaten som returneras av Get-Help.

.FUNCTIONALITY

Nyckelorden som beskriver den avsedda användningen av funktionen. Parametern Functionality för Get-Help använder det här värdet för att filtrera sökresultaten som returneras av Get-Help.

.FORWARDHELPTARGETNAME <Command-Name>

Omdirigerar till hjälpavsnittet för det angivna kommandot. Du kan omdirigera användare till vilket hjälpavsnitt som helst, inklusive hjälpinnehåll för en funktion, ett skript, en cmdlet eller en leverantör.

# .FORWARDHELPTARGETNAME <Command-Name>

.FORWARDHELPCATEGORY

Anger hjälpkategorin för objektet i .FORWARDHELPTARGETNAME. Giltiga värden är Alias, Cmdlet, HelpFile, Function, Provider, General, FAQ, Glossary, ScriptCommand, ExternalScript, Filtereller All. Använd det här nyckelordet för att undvika konflikter när det finns kommandon med samma namn.

# .FORWARDHELPCATEGORY <Category>

.REMOTEHELPRUNSPACE <PSSession-variable>

Anger en session som innehåller hjälpavsnittet. Ange en variabel som innehåller ett PSSession- objekt. Det här nyckelordet används av cmdleten [Export-PSSession][09] för att hitta hjälpinnehållet för de exporterade kommandona.

# .REMOTEHELPRUNSPACE <PSSession-variable>

.EXTERNALHELP

Anger en XML-baserad hjälpfil för skriptet eller funktionen.

# .EXTERNALHELP <XML Help File>

Nyckelordet .EXTERNALHELP krävs när en funktion eller ett skript dokumenteras i XML-filer. Utan det här nyckelordet kan Get-Help inte hitta den XML-baserade hjälpfilen för funktionen eller skriptet.

Nyckelordet .EXTERNALHELP har företräde framför andra kommentarsbaserade hjälpnyckelord. Om .EXTERNALHELP finns visar Get-Help inte kommentarsbaserad hjälp, även om det inte kan hitta ett hjälpavsnitt som matchar värdet för nyckelordet .EXTERNALHELP.

Om funktionen exporteras av en modul anger du värdet för nyckelordet .EXTERNALHELP till ett filnamn utan sökväg. Get-Help söker efter det angivna filnamnet i en språkspecifik underkatalog i modulkatalogen. Det finns inga krav på namnet på den XML-baserade hjälpfilen för en funktion. Från och med PowerShell 5.0 kan funktioner som exporteras av en modul dokumenteras i en hjälpfil med namnet på modulen. Du behöver inte använda .EXTERNALHELP nyckelord för kommentarer. Om funktionen Test-Function till exempel exporteras av modulen MyModule kan du ge hjälpfilen MyModule-help.xmlnamnet . Cmdleten Get-Help söker efter hjälp för Test-Function funktionen i MyModule-help.xml filen i modulkatalogen.

Om funktionen inte ingår i en modul inkluderar du en sökväg till den XML-baserade hjälpfilen. Om värdet innehåller en sökväg och sökvägen innehåller UI-kulturspecifika underkataloger söker Get-Help rekursivt efter en XML-fil med namnet på skriptet eller funktionen i enlighet med de standarder för språkåterställning som fastställts för Windows, precis som i en modulkatalog.

Mer information om det XML-baserade hjälpfilformatet för cmdlet-hjälp finns i Så här skriver du cmdlet-hjälpen.