Cómo agregar tipos de entrada a un tema de ayuda de cmdlet
Nota
La creación manual de ayuda basada en XML es muy difícil. El módulo PlatyPS le permite escribir ayuda en Markdown y luego convertirla en ayuda basada en XML. Esto hace que sea mucho más fácil escribir y mantener la ayuda. PlatyPS también puede crear paquetes de ayuda actualizables para usted. Para obtener más información, consulte Crear ayuda basada en XML utilizando PlatyPS.
Esta sección describe cómo agregar una sección INPUTS a un tema de Ayuda del cmdlet de PowerShell. La sección INPUTS enumera las clases de objetos .NET que el cmdlet acepta como entrada de la canalización, ya sea por valor o por nombre de propiedad.
No hay límite para la cantidad de clases que puede agregar a una sección INPUTS. Los tipos de entrada están encerrados en un nodo <command:inputTypes>, con cada clase encerrada en un elemento <command:inputType>.
El esquema incluye dos elementos <maml:description> en cada elemento <command:inputType>. Sin embargo, el cmdlet Get-Help muestra solo el contenido del elemento <command:inputType>/
A partir de PowerShell 3.0, el cmdlet Get-Help muestra el contenido del elemento <maml:uri>. Este elemento le permite dirigir a los usuarios a temas que describen la clase .NET.
El siguiente XML muestra el nodo <maml:inputTypes>.
<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>
El siguiente XML muestra un ejemplo del uso del nodo <maml:inputTypes> para documentar un tipo de entrada.
<command:inputTypes>
<command:inputType>
<dev:type>
<maml:name>System.DateTime</maml:name>
<maml:uri>https://learn.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>