Het Help-bestand voor cmdlets maken

In deze sectie wordt beschreven hoe u een geldig XML-bestand maakt dat inhoud bevat voor Windows PowerShell Help-onderwerpen over cmdlets. In deze sectie wordt beschreven hoe u het Help-bestand een naam geeft, hoe u de juiste XML-headers toevoegt en hoe u knooppunten toevoegt die de verschillende secties van de Help-inhoud van de cmdlet bevatten.

Notitie

Open een van de dll-Help.xml bestanden in de Windows PowerShell installatiemap voor een volledige weergave van een Help-bestand. Het bestand bevat bijvoorbeeld Microsoft.PowerShell.Commands.Management.dll-Help.xml inhoud voor verschillende PowerShell-cmdlets.

Help-bestand voor cmdlets maken

1. Maak een tekstbestand en sla het op met behulp van UTF8-codering. De bestandsnaam moet de volgende indeling hebben, zodat Windows PowerShell deze kan detecteren als een Help-bestand met cmdlets.

   <PSSnapInAssemblyName>.dll-Help.xml

2. Voeg de volgende XML-headers toe aan het tekstbestand. Houd er rekening mee dat het bestand wordt gevalideerd op basis van het MAML-schema (Microsoft Assistance Markup Language). PowerShell biedt momenteel geen hulpprogramma's om het bestand te valideren.

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

3. Voeg een opdrachtknooppunt toe aan het Help-bestand van de cmdlet voor elke cmdlet in de assembly. Elk knooppunt in het opdrachtknooppunt heeft betrekking op de verschillende secties van het Help-onderwerp van de cmdlet.

   De volgende tabel bevat het XML-element voor elk knooppunt, gevolgd door een beschrijving van elk knooppunt.

   Knooppunt	Description
   <details>	Hiermee voegt u inhoud toe voor de secties NAME en SYNOPSIS van het Help-onderwerp van de cmdlet. Zie De cmdlet-naam en synopsis toevoegen voor meer informatie.
   <maml:description>	Hiermee voegt u inhoud toe voor de sectie DESCRIPTION van het Help-onderwerp van de cmdlet. Zie De gedetailleerde beschrijving toevoegen aan een Help-onderwerp voor cmdlets voor meer informatie.
   <command:syntax>	Hiermee voegt u inhoud toe voor de sectie SYNTAXIS van het Help-onderwerp van de cmdlet. Zie Syntaxis toevoegen aan een Help-onderwerp voor cmdlets voor meer informatie.
   <command:parameters>	Hiermee voegt u inhoud toe voor de sectie PARAMETERS van het Help-onderwerp van de cmdlet. Zie Parameters toevoegen aan een Help-onderwerp voor cmdlets voor meer informatie.
   <command:inputTypes>	Hiermee voegt u inhoud toe voor de sectie INVOER van het Help-onderwerp van de cmdlet. Zie Invoertypen toevoegen aan een Help-onderwerp voor cmdlets voor meer informatie.
   <command:returnValues>	Hiermee voegt u inhoud toe voor de sectie OUTPUTS van het Help-onderwerp van de cmdlet. Zie Retourwaarden toevoegen aan een Help-onderwerp voor cmdlets voor meer informatie.
   <maml:alertset>	Hiermee voegt u inhoud toe voor de sectie NOTES van het Help-onderwerp van de cmdlet. Zie Notities toevoegen aan een Help-onderwerp voor cmdlets voor meer informatie.
   <command:examples>	Hiermee voegt u inhoud toe voor de sectie VOORBEELDEN van het Help-onderwerp van de cmdlet. Zie Voorbeelden toevoegen aan een Help-onderwerp voor cmdlets voor meer informatie.
   <maml:relatedLinks>	Hiermee voegt u inhoud toe voor de sectie RELATED LINKS van het Help-onderwerp van de cmdlet. Zie Verwante koppelingen toevoegen aan een Help-onderwerp voor cmdlets voor meer informatie.

Voorbeeld

Hier volgt een voorbeeld van een opdrachtknooppunt met de knooppunten voor de verschillende secties van het Help-onderwerp van de cmdlet.

<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>

Zie ook

De cmdlet-naam en synopsis toevoegen

Gedetailleerde beschrijving toevoegen aan een Help-onderwerp voor cmdlets

Syntaxis toevoegen aan een Help-onderwerp voor cmdlets

Parameters toevoegen aan een Help-onderwerp voor cmdlets

Invoertypen toevoegen aan een Help-onderwerp voor cmdlets

Retourwaarden toevoegen aan een Help-onderwerp voor cmdlets

Notities toevoegen aan een Help-onderwerp voor cmdlets

Voorbeelden toevoegen aan een Help-onderwerp voor cmdlets

Gerelateerde koppelingen toevoegen aan een Help-onderwerp voor cmdlets

Windows PowerShell SDK