Cómo agregar notas 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 NOTAS a un tema de Ayuda de cmdlet de PowerShell. La sección NOTAS se utiliza para explicar detalles que no encajan fácilmente en otras secciones estructuradas, como una explicación más detallada de un parámetro. Este contenido podría incluir comentarios sobre cómo funciona el cmdlet con un proveedor específico, algunos usos únicos, pero importantes, del cmdlet o formas de evitar posibles condiciones de error.
La sección NOTAS se define utilizando un único nodo <maml:alertset>. No hay límites para la cantidad de notas que puede agregar a una sección de Notas. Para cada nota, agregue un par de etiquetas <maml:alert> al nodo <maml:alertset>. El contenido de cada nota se agrega dentro de un conjunto de etiquetas <maml:para>. Utilice etiquetas <maml:para> en blanco para el espaciado.
<maml:alertSet>
<maml:title>Optional title for Note</maml:title>
<maml:alert>
<maml:para>Note 1</maml:para>
<maml:para>Note a</maml:para>
</maml:alert>
<maml:alert>
<maml:para>Note 2</maml:para>
</maml:alert>
</maml:alertSet>