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

Microsoft .NET Framework-typerna av objekt som kan skickas till funktionen eller skriptet. Du kan också ta med en beskrivning av indataobjekten.

.OUTPUTS

.NET Framework-typen för de objekt som cmdleten returnerar. Du kan också ta med en beskrivning av de returnerade objekten.

.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 alla hjälpavsnitt, inklusive hjälpavsnitt för en funktion, ett skript, en cmdlet eller en provider.

.FORWARDHELPCATEGORY <Category>

Anger hjälpkategorin för objektet i .FORWARDHELPTARGETNAME. Använd det här nyckelordet för att undvika konflikter när det finns kommandon med samma namn.

Giltiga värden är:

• Alias
• Cmdlet
• Hjälpfil
• Function
• Provider
• General
• FAQ
• Glossary
• ScriptCommand
• ExternalScript
• Filter
• Alla

.REMOTEHELPRUNSPACE <PSSession-variable>

Anger en session som innehåller hjälpavsnittet. Ange en variabel som innehåller en PSSession. Det här nyckelordet används av cmdleten Export-PSSession för att hitta hjälpavsnitten för de exporterade kommandona.

.EXTERNALHELP <XML Help File>

Anger sökvägen och/eller namnet på en XML-baserad hjälpfil för skriptet eller funktionen.

Nyckelordet .EXTERNALHELP talar om för cmdleten Get-Help för att få hjälp med skriptet eller funktionen i en XML-baserad fil. Nyckelordet .EXTERNALHELP krävs när du använder en XML-baserad hjälpfil för ett skript eller en funktion. Utan den hittar Get-Help ingen hjälpfil för funktionen eller skriptet.

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.

När funktionen exporteras av en skriptmodul ska värdet för .EXTERNALHELP vara ett filnamn utan sökväg. Get-Help söker efter filen i en språkspecifik underkatalog i modulkatalogen. Det finns inga krav för filnamnet, men bästa praxis är att använda följande filnamnsformat: <ScriptModule>.psm1-help.xml.

När funktionen inte är associerad med en modul ska du inkludera en sökväg och filnamn i värdet för nyckelordet .EXTERNALHELP. Om den angivna sökvägen till XML-filen 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 för alla XML-baserade hjälpavsnitt.

Mer information om cmdleten Hjälp XML-baserat hjälpfilformat finns i Skriva Windows PowerShell-cmdlethjälp.