Skapa cmdlet-hjälpfilen

Artikel
05/13/2022

I det här avsnittet beskrivs hur du skapar en giltig XML-fil som innehåller innehåll för Windows PowerShell cmdlet-hjälpavsnitt. I det här avsnittet beskrivs hur du namnger hjälpfilen, hur du lägger till lämpliga XML-huvuden och hur du lägger till noder som innehåller de olika avsnitten i cmdlet-hjälpinnehållet.

Anteckning

Om du vill ha en fullständig vy över en hjälpfil öppnar du en av filerna dll-Help.xml som finns i Windows PowerShell installationskatalog. Filen innehåller till exempel Microsoft.PowerShell.Commands.Management.dll-Help.xml innehåll för flera av PowerShell-cmdletarna.

Så här skapar du en cmdlet-hjälpfil

Skapa en textfil och spara den med UTF8-kodning. Filnamnet måste ha följande format så att Windows PowerShell kan identifiera det som en cmdlet-hjälpfil.

<PSSnapInAssemblyName>.dll-Help.xml
Lägg till följande XML-huvuden i textfilen. Tänk på att filen verifieras mot MAML-schemat (Microsoft Assistance Markup Language). PowerShell tillhandahåller för närvarande inga verktyg för att verifiera filen.

<?xml version="1.0" encoding="utf-8" ?> <helpItems xmlns="http://msh" schema="maml">

Lägg till en kommandonod i cmdlet-hjälpfilen för varje cmdlet i sammansättningen. Varje nod i kommandonoden relaterar till de olika avsnitten i cmdlet-hjälpavsnittet.

I följande tabell visas XML-elementet för varje nod följt av en beskrivning av varje nod.

Nod	Description
`<details>`	Lägger till innehåll för avsnitten NAME och SYNOPSIS i cmdlet-hjälpavsnittet. Mer information finns i Så här lägger du till cmdlet-namnet och Synopsis.
`<maml:description>`	Lägger till innehåll för avsnittet BESKRIVNING i cmdlet-hjälpavsnittet. Mer information finns i Så här lägger du till den detaljerade beskrivningen i ett cmdlet-hjälpavsnitt.
`<command:syntax>`	Lägger till innehåll för syntaxavsnittet i cmdlet-hjälpavsnittet. Mer information finns i Så här lägger du till syntax i ett cmdlet-hjälpavsnitt.
`<command:parameters>`	Lägger till innehåll för avsnittet PARAMETRAR i cmdlet-hjälpavsnittet. Mer information finns i Så här lägger du till parametrar i ett cmdlet-hjälpavsnitt.
`<command:inputTypes>`	Lägger till innehåll för avsnittet INPUTS i cmdlet-hjälpavsnittet. Mer information finns i Så här lägger du till indatatyper i ett cmdlet-hjälpavsnitt.
`<command:returnValues>`	Lägger till innehåll för avsnittet OUTPUTS i cmdlet-hjälpavsnittet. Mer information finns i How to Add Return Values to a Cmdlet Help Topic (Så här lägger du till returvärden i ett cmdlet-hjälpavsnitt).
`<maml:alertset>`	Lägger till innehåll för avsnittet ANTECKNINGAR i cmdlet-hjälpavsnittet. Mer information finns i Så här lägger du till anteckningar i ett cmdlet-hjälpavsnitt.
`<command:examples>`	Lägger till innehåll för avsnittet EXEMPEL i cmdlet-hjälpavsnittet. Mer information finns i Så här lägger du till exempel i ett cmdlet-hjälpavsnitt.
`<maml:relatedLinks>`	Lägger till innehåll för avsnittet RELATERADE LÄNKAR i cmdlet-hjälpavsnittet. Mer information finns i Så här lägger du till relaterade länkar till ett cmdlet-hjälpavsnitt.

Exempel

Här är ett exempel på en kommandonod som innehåller noderna för de olika avsnitten i cmdlet-hjälpavsnittet.

<command:command
  xmlns:maml="http://schemas.microsoft.com/maml/2004/10"
  xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"
  xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
  <command:details>
    <!--Add name and synopsis here-->
  </command:details>
  <maml:description>
    <!--Add detailed description here-->
  </maml:description>
  <command:syntax>
    <!--Add syntax information here-->
  </command:syntax>
  <command:parameters>
    <!--Add parameter information here-->
  </command:parameters>
  <command:inputTypes>
    <!--Add input type information here-->
  </command:inputTypes>
  <command:returnValues>
    <!--Add return value information here-->
  </command:returnValues>
  <maml:alertSet>
    <!--Add Note information here-->
  </maml:alertSet>
  <command:examples>
    <!--Add cmdlet examples here-->
  </command:examples>
  <maml:relatedLinks>
    <!--Add links to related content here-->
  </maml:relatedLinks>
</command:command>