Jak dodać typy danych wejściowych do tematu pomocy dotyczącego polecenia cmdlet

W tej sekcji opisano sposób dodawania sekcji INPUTS do tematu pomocy dotyczącego poleceń cmdlet programu PowerShell. Sekcja INPUTS zawiera listę klas obiektów .NET, które polecenie cmdlet akceptuje jako dane wejściowe z potoku według wartości lub nazwy właściwości.

Nie ma żadnego limitu liczby klas, które można dodać do sekcji INPUTS. Typy wejściowe są ujęte w węzeł, a <command:inputTypes> każda klasa jest ujęta w <command:inputType> element.

Schemat zawiera dwa elementy <maml:description> w każdym <command:inputType> elemencie. Jednak Get-Help polecenie cmdlet wyświetla tylko zawartość <command:inputType>/<maml:description> elementu.

Począwszy od programu PowerShell 3.0, Get-Help polecenie cmdlet wyświetla zawartość <maml:uri> elementu. Ten element umożliwia kierowanie użytkowników do tematów opisujących klasę .NET.

Poniższy kod XML przedstawia <maml:inputTypes> węzeł.

<command:inputTypes>
  <command:inputType>
    <dev:type>
      <maml:name> Class name </maml:name>
      <maml:uri>  URI of a topic that describes the class </maml:uri>
      <maml:description/>
    </dev:type>
    <maml:description>
      <maml:para> Brief description </maml:para>
    </maml:description>
  </command:inputType>
</command:inputTypes>

Poniższy kod XML przedstawia przykład użycia węzła <maml:inputTypes> do udokumentowania typu danych wejściowych.

<command:inputTypes>
  <command:inputType>
    <dev:type>
      <maml:name>System.DateTime</maml:name>
      <maml:uri>https://docs.microsoft.com/dotnet/api/system.datetime</maml:uri>
      <maml:description/>
    </dev:type>
    <maml:description>
      <maml:para> You can pipe a date to the Set-Date cmdlet. <maml:para>
    <maml:description>
  </command:inputType>
</command:inputTypes>