Namnge hjälpfiler

I det här avsnittet beskrivs hur du namnger en XML-baserad hjälpfil så att cmdleten Get-Help kan hitta den. Namn kraven varierar för varje kommando typ.

Cmdlet-hjälpfiler

Hjälp filen för en C#-cmdlet måste namnges för sammansättningen där cmdleten definieras. Använd följande fil namns format:

<AssemblyName>.dll-help.xml

Sammansättnings namnets format måste anges även om sammansättningen är en kapslad modul.

Till exempel definieras cmdleten Get-WinEvent i Microsoft.PowerShell.Diagnostics.dll sammansättningen. Get-HelpCmdleten söker efter ett hjälp avsnitt för Get-WinEvent cmdleten endast i Microsoft.PowerShell.Diagnostics.dll-help.xml filen i modul-katalogen.

Hjälp filer för Provider

Hjälp filen för en PowerShell-Provider måste namnges för sammansättningen där providern definieras. Använd följande fil namns format:

<AssemblyName>.dll-help.xml

Sammansättnings namnets format måste anges även om sammansättningen är en kapslad modul.

Till exempel definieras certifikat leverantören i Microsoft.PowerShell.Security.dll sammansättningen. Get-HelpCmdleten söker efter ett hjälp avsnitt för certifikat leverantören enbart i Microsoft.PowerShell.Security.dll-help.xml filen i modul-katalogen.

Funktions hjälp filer

Funktioner kan dokumenteras med hjälp av en kommenterad hjälp eller dokumenteras i en XML-hjälpfil. När funktionen dokumenteras i en XML-fil måste funktionen ha ett .ExternalHelp kommentar nyckelord som associerar funktionen med XML-filen. Annars Get-Help kan inte cmdlet: en hitta hjälp filen.

Det finns inga tekniska krav för namnet på en funktions hjälp fil. Vi rekommenderar dock att du namnger hjälp filen för den skript-modul där funktionen definieras. Till exempel definieras följande funktion i MyModule.psm1 filen.

#.ExternalHelp MyModule.psm1-help.xml
function Test-Function { ... }

Hjälp filer för CIM-kommando

Hjälp filen för ett CIM-kommando måste namnges för den CDXLM-fil där CIM-kommandot definieras. Använd följande fil namns format:

<FileName>.cdxml-help.xml

CIM-kommandon definieras i CDXLM-filer som kan inkluderas i moduler som kapslade moduler. När CIM-kommandot importeras till sessionen som en funktion lägger PowerShell .ExternalHelp till ett kommentar nyckelord till funktions definitionen som associerar funktionen med en XML-hjälpfil som heter för cdxlm-filen där CIM-kommandot definieras.

Hjälpfiler för skript arbets flöde

Skript arbets flöden som ingår i moduler kan dokumenteras i XML-baserade hjälpfiler. Det finns inga tekniska krav för namnet på hjälp filen. Vi rekommenderar dock att du namnger hjälp filen för den skript-modul där skript arbets flödet har definierats. Exempel:

<ScriptModule>.psm1-help.xml

Till skillnad från andra skriptbaserade kommandon behöver inte skript arbets flöden ett .ExternalHelp kommentars nyckelord för att koppla dem till en hjälp fil. I stället söker PowerShell i den UI-kulturbaserade under kataloger i modul katalogen för XML-baserade hjälpfiler och söker efter hjälp för skript arbets flödet i alla filer. .ExternalHelp nyckelordet comment ignoreras.

Eftersom .ExternalHelp nyckelordet comment ignoreras, Get-Help kan cmdleten bara hitta hjälp för skript arbets flöden när de ingår i moduler.