Erstellen der Cmdlet-Hilfedatei

2022-05-13

In diesem Abschnitt wird beschrieben, wie Sie eine gültige XML-Datei erstellen, die Inhalte für Windows PowerShell Cmdlet-Hilfethemen enthält. In diesem Abschnitt wird erläutert, wie Sie die Hilfedatei benennen, wie Sie die entsprechenden XML-Header hinzufügen und Knoten hinzufügen, die die verschiedenen Abschnitte des Cmdlet-Hilfeinhalts enthalten.

Hinweis

Öffnen Sie eine der Dateien, die dll-Help.xml sich im Windows PowerShell Installationsverzeichnis befinden, um eine vollständige Ansicht einer Hilfedatei anzuzeigen. Beispielsweise enthält die Microsoft.PowerShell.Commands.Management.dll-Help.xml Datei Inhalte für mehrere PowerShell-Cmdlets.

So erstellen Sie eine Cmdlet-Hilfedatei

Erstellen Sie eine Textdatei, und speichern Sie sie mithilfe der UTF8-Codierung. Der Dateiname muss das folgende Format aufweisen, damit Windows PowerShell es als Cmdlet-Hilfedatei erkennen kann.

<PSSnapInAssemblyName>.dll-Help.xml
Fügen Sie die folgenden XML-Kopfzeilen zur Textdatei hinzu. Beachten Sie, dass die Datei anhand des MAML-Schemas (Microsoft Assistance Markup Language) überprüft wird. Derzeit stellt PowerShell keine Tools bereit, um die Datei zu überprüfen.

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

Fügen Sie dem Cmdlet-Hilfedatei für jedes Cmdlet in der Assembly einen Befehlsknoten hinzu. Jeder Knoten innerhalb des Befehlsknotens bezieht sich auf die verschiedenen Abschnitte des Cmdlet-Hilfethemas.

In der folgenden Tabelle sind die XML-Elemente für jeden Knoten aufgeführt, gefolgt von einer Beschreibung jedes Knotens.

Node	BESCHREIBUNG
`<details>`	Fügt Inhalte für die Abschnitte NAME und SYNOPSIS des Cmdlet-Hilfethemas hinzu. Weitere Informationen finden Sie unter Hinzufügen des Cmdletnamens und der Synopsis.
`<maml:description>`	Fügt Inhalt für den ABSCHNITT BESCHREIBUNG des Cmdlet-Hilfethemas hinzu. Weitere Informationen finden Sie unter Hinzufügen der detaillierten Beschreibung zu einem Cmdlet-Hilfethema.
`<command:syntax>`	Fügt Inhalt für den SYNTAX-Abschnitt des Cmdlet-Hilfethemas hinzu. Weitere Informationen finden Sie unter Hinzufügen von Syntax zu einem Cmdlet-Hilfethema.
`<command:parameters>`	Fügt Inhalt für den PARAMETER-Abschnitt des Cmdlet-Hilfethemas hinzu. Weitere Informationen finden Sie unter Hinzufügen von Parametern zu einem Cmdlet-Hilfethema.
`<command:inputTypes>`	Fügt Inhalt für den INPUT-Abschnitt des Cmdlet-Hilfethemas hinzu. Weitere Informationen finden Sie unter Hinzufügen von Eingabetypen zu einem Cmdlet-Hilfethema.
`<command:returnValues>`	Fügt Inhalt für den Abschnitt "OUTPUTS" des Cmdlet-Hilfethemas hinzu. Weitere Informationen finden Sie unter Hinzufügen von Rückgabewerten zu einem Cmdlet-Hilfethema.
`<maml:alertset>`	Fügt Inhalte für den NOTES-Abschnitt des Cmdlet-Hilfethemas hinzu. Weitere Informationen finden Sie unter Hinzufügen von Notizen zu einem Cmdlet-Hilfethema.
`<command:examples>`	Fügt Inhalt für den Abschnitt "BEISPIELE" des Cmdlet-Hilfethemas hinzu. Weitere Informationen finden Sie unter Hinzufügen von Beispielen zu einem Cmdlet-Hilfethema.
`<maml:relatedLinks>`	Fügt Inhalt für den Abschnitt "VERWANDTE LINKS" des Cmdlet-Hilfethemas hinzu. Weitere Informationen finden Sie unter Hinzufügen verwandter Links zu einem Cmdlet-Hilfethema.

Beispiel

Nachfolgend finden Sie ein Beispiel für einen Befehlsknoten , der die Knoten für die verschiedenen Abschnitte des Cmdlet-Hilfethemas enthält.

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