Jak utworzyć plik pomocy dotyczącej poleceń cmdlet

Artykuł
05/13/2022

W tej sekcji opisano sposób tworzenia prawidłowego pliku XML zawierającego zawartość tematów pomocy Windows PowerShell poleceń cmdlet. W tej sekcji omówiono sposób nazywania pliku Pomocy, dodawania odpowiednich nagłówków XML oraz dodawania węzłów, które będą zawierać różne sekcje zawartości Pomocy polecenia cmdlet.

Uwaga

Aby uzyskać pełny widok pliku Pomocy, otwórz jeden z dll-Help.xml plików znajdujących się w katalogu instalacyjnym Windows PowerShell. Na przykład Microsoft.PowerShell.Commands.Management.dll-Help.xml plik zawiera zawartość kilku poleceń cmdlet programu PowerShell.

Jak utworzyć plik pomocy polecenia cmdlet

Utwórz plik tekstowy i zapisz go przy użyciu kodowania UTF8. Nazwa pliku musi mieć następujący format, aby Windows PowerShell mógł wykryć go jako plik pomocy polecenia cmdlet.

<PSSnapInAssemblyName>.dll-Help.xml
Dodaj następujące nagłówki XML do pliku tekstowego. Należy pamiętać, że plik zostanie zweryfikowany względem schematu języka MAML (Microsoft Assistance Markup Language). Obecnie program PowerShell nie udostępnia żadnych narzędzi do sprawdzania poprawności pliku.

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

Dodaj węzeł Polecenia do pliku Pomocy polecenia dla każdego polecenia cmdlet w zestawie. Każdy węzeł w węźle Polecenia odnosi się do różnych sekcji tematu Pomocy polecenia cmdlet.

W poniższej tabeli wymieniono element XML dla każdego węzła, a następnie opisy każdego węzła.

Węzeł	Opis
`<details>`	Dodaje zawartość sekcji NAME i SYNOPSIS w temacie Pomocy dotyczącej polecenia cmdlet. Aby uzyskać więcej informacji, zobacz How to Add the Cmdlet Name and Synopsis (Jak dodać nazwę polecenia cmdlet i synopsis).
`<maml:description>`	Dodaje zawartość sekcji DESCRIPTION tematu Pomocy polecenia cmdlet. Aby uzyskać więcej informacji, zobacz How to Add the Detailed Description to a Cmdlet Help Topic (Jak dodać szczegółowy opis do tematu pomocy dotyczącej poleceń cmdlet).
`<command:syntax>`	Dodaje zawartość sekcji SKŁADNI tematu Pomocy polecenia cmdlet. Aby uzyskać więcej informacji, zobacz How to Add Syntax to a Cmdlet Help Topic (Jak dodać składnię do tematu pomocy dotyczącej poleceń cmdlet).
`<command:parameters>`	Dodaje zawartość sekcji PARAMETERS tematu Pomocy polecenia cmdlet. Aby uzyskać więcej informacji, zobacz How to Add Parameters to a Cmdlet Help Topic (Jak dodawać parametry do tematu pomocy dotyczącej poleceń cmdlet).
`<command:inputTypes>`	Dodaje zawartość sekcji INPUTS w temacie Pomocy dotyczącej polecenia cmdlet. Aby uzyskać więcej informacji, zobacz How to Add Input Types to a Cmdlet Help Topic (Jak dodawać typy wejściowe do tematu pomocy dotyczącej poleceń cmdlet).
`<command:returnValues>`	Dodaje zawartość sekcji OUTPUTS tematu Pomocy dotyczącej polecenia cmdlet. Aby uzyskać więcej informacji, zobacz How to Add Return Values to a Cmdlet Help Topic (Jak dodawać wartości zwracane do tematu pomocy polecenia cmdlet).
`<maml:alertset>`	Dodaje zawartość sekcji UWAGI w temacie Pomocy dotyczącej polecenia cmdlet. Aby uzyskać więcej informacji, zobacz How to add Notes to a Cmdlet Help Topic (Jak dodawać notatki do tematu pomocy polecenia cmdlet).
`<command:examples>`	Dodaje zawartość sekcji PRZYKŁADY tematu Pomocy polecenia cmdlet. Aby uzyskać więcej informacji, zobacz How to Add Examples to a Cmdlet Help Topic (Jak dodawać przykłady do tematu pomocy polecenia cmdlet).
`<maml:relatedLinks>`	Dodaje zawartość sekcji RELATED LINKS w temacie Pomoc polecenia cmdlet. Aby uzyskać więcej informacji, zobacz How to Add Related Links to a Cmdlet Help Topic (Jak dodawać powiązane linki do tematu pomocy polecenia cmdlet).

Przykład

Oto przykład węzła polecenia , który zawiera węzły dla różnych sekcji tematu Pomocy polecenia 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>