Cómo agregar tipos de entrada a un tema de Ayuda del cmdlet

En esta sección se describe cómo agregar una sección INPUTS a un tema de Ayuda del cmdlet de PowerShell. En la sección INPUTS se enumeran las clases .NET de objetos que el cmdlet acepta como entrada de la canalización, ya sea por valor o por nombre de propiedad.

No hay ningún límite en el número de clases que se pueden agregar a una sección INPUTS. Los tipos de entrada se incluyen en un <command:inputTypes> nodo, con cada clase incluida en un <command:inputType> elemento .

El esquema incluye dos <maml:description> elementos en cada <command:inputType> elemento. Sin embargo, Get-Help el cmdlet muestra solo el contenido del <command:inputType>/<maml:description> elemento.

A partir de PowerShell 3.0, el Get-Help cmdlet muestra el contenido del <maml:uri> elemento. Este elemento le permite dirigir a los usuarios a temas que describen la clase .NET.

El siguiente XML muestra el <maml:inputTypes> nodo.

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

En el xml siguiente se muestra un ejemplo de uso del <maml:inputTypes> nodo para documentar un tipo de entrada.

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