Feedback

Nyckelord för kommentarsbaserad hjälp

  • Artikel
  • 3 minuter för att läsa

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

Nyckelord i Comment-Based hjälp

Följande är giltiga kommentarsbaserade hjälpnyckelord. De visas i den ordning som de vanligtvis visas i ett hjälpavsnitt tillsammans med avsedd användning. Dessa nyckelord kan visas i valfri ordning i den kommentarsbaserade hjälpen, och de är inte fallkänsliga.

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

.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, Param men ordningen i vilken parametrarna visas i instruktionen eller funktionsdeklarationen avgör i vilken ordning parametrarna visas i hjälpavsnittet. Ändra ordningen på parametrarna i hjälpavsnittet genom att ändra ordningen på parametrarna i -instruktionen Param eller funktionsdeklarationen.

Du kan också ange en parameterbeskrivning genom att placera en kommentar i instruktionen Param omedelbart före parametervariabelnamnet. Om du använder både en instruktionskommentar Param .PARAMETER .PARAMETER och ett nyckelord används beskrivningen som är associerad med nyckelordet och instruktionskommentaren Param 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 typer av objekt som kan ledas till funktionen eller skriptet. Du kan också inkludera en beskrivning av indataobjekten.

.OUTPUTS

Den .NET Framework typen av objekt som cmdleten returnerar. Du kan också inkludera en beskrivning av de returnerade objekten.

.NOTES

Ytterligare information om funktionen eller skriptet.

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.

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

.COMPONENT

Namnet på tekniken eller funktionen som funktionen eller skriptet använder, eller som den är relaterad till. Parametern Component för använder Get-Help 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 använder Get-Help 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 använder Get-Help 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
  • HelpFile
  • Function
  • Provider
  • General
  • FAQ
  • Glossary
  • ScriptCommand
  • ExternalScript
  • Filtrera
  • 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 Export-PSSession cmdleten 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 get-help-cmdleten att få hjälp för 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 inte någon 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 get-Help-cmdleten inte kommentarsbaserad hjälp, även om den inte kan hitta en hjälpfil som matchar värdet för nyckelordet .

När funktionen exporteras av en skriptmodul ska värdet för .EXTERNALHELP vara ett filnamn utan en 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 filformat: <ScriptModule>.psm1-help.xml.

När funktionen inte är associerad med en modul ska du inkludera en sökväg och ett 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 underkatalogerna rekursivt efter en XML-fil med namnet på skriptet eller funktionen i enlighet med språkstandarderna för Windows, precis som för alla XML-baserade hjälpämnen.

Mer information om det XML-baserade hjälpfilformatet för cmdlet-hjälp finns i Skriva Windows PowerShell cmdlet-hjälpen.