Cómo crear el archivo de Ayuda del cmdletHow to Create the Cmdlet Help File

En esta sección se describe cómo crear un archivo XML válido que contenga contenido para los temas de ayuda de los cmdlets de Windows PowerShell.This section describes how to create a valid XML file that contains content for Windows PowerShell cmdlet Help topics. En esta sección se describe cómo asignar un nombre al archivo de ayuda, cómo agregar los encabezados XML adecuados y cómo agregar nodos que contendrán las diferentes secciones del contenido de la ayuda del cmdlet.This section discusses how to name the Help file, how to add the appropriate XML headers, and how to add nodes that will contain the different sections of the cmdlet Help content.

Nota

Para obtener una vista completa de un archivo de ayuda, abra uno de los archivos que se dll-Help.xml encuentran en el directorio de instalación de Windows PowerShell.For a complete view of a Help file, open one of the dll-Help.xml files located in the Windows PowerShell installation directory. Por ejemplo, el Microsoft.PowerShell.Commands.Management.dll-Help.xml archivo contiene contenido para algunos de los cmdlets de PowerShell.For example, the Microsoft.PowerShell.Commands.Management.dll-Help.xml file contains content for several of the PowerShell cmdlets.

Cómo crear un archivo de ayuda de cmdletHow to Create a Cmdlet Help File

  1. Cree un archivo de texto y guárdelo con la codificación UTF8.Create a text file and save it using UTF8 encoding. El nombre de archivo debe tener el formato siguiente para que Windows PowerShell pueda detectarlo como un archivo de ayuda de cmdlet.The filename must have the following format so that Windows PowerShell can detect it as a cmdlet Help file.

    <PSSnapInAssemblyName>.dll-Help.xml

  2. Agregue los siguientes encabezados XML al archivo de texto.Add the following XML headers to the text file. Tenga en cuenta que el archivo se validará con el esquema del lenguaje de marcado de asistencia de Microsoft (MAML).Be aware that the file will be validated against the Microsoft Assistance Markup Language (MAML) schema. Actualmente, PowerShell no proporciona ninguna herramienta para validar el archivo.Currently, PowerShell does not provide any tools to validate the file.

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

  3. Agregue un nodo de comando al archivo de ayuda de cmdlet para cada cmdlet en el ensamblado.Add a Command node to the cmdlet Help file for each cmdlet in the assembly. Cada nodo dentro del nodo comando se relaciona con las distintas secciones del tema de ayuda del cmdlet.Each node within the Command node relates to the different sections of the cmdlet Help topic.

    En la tabla siguiente se muestra el elemento XML para cada nodo, seguido de una descripción de cada nodo.The following table lists the XML element for each node, followed by a descriptions of each node.

    NodoNode DescripciónDescription
    <details> Agrega contenido para las secciones nombre y Sinopsis del tema de ayuda del cmdlet.Adds content for the NAME and SYNOPSIS sections of the cmdlet Help topic. Para obtener más información, consulte Agregar el nombre del cmdlet y la Sinopsis.For more information, see How to Add the Cmdlet Name and Synopsis.
    <maml:description> Agrega contenido para la sección Descripción del tema de ayuda del cmdlet.Adds content for the DESCRIPTION section of the cmdlet Help topic. Para obtener más información, consulte Cómo agregar la descripción detallada a un tema de ayuda de un cmdlet.For more information, see How to Add the Detailed Description to a Cmdlet Help Topic.
    <command:syntax> Agrega contenido para la sección de sintaxis del tema de ayuda del cmdlet.Adds content for the SYNTAX section of the cmdlet Help topic. Para obtener más información, consulte el tema de ayuda agregar sintaxis a un cmdlet.For more information, see How to Add Syntax to a Cmdlet Help Topic.
    <command:parameters> Agrega contenido para la sección de parámetros del tema de ayuda del cmdlet.Adds content for the PARAMETERS section of the cmdlet Help topic. Para obtener más información, vea el tema de ayuda cómo agregar parámetros a un cmdlet.For more information, see How to Add Parameters to a Cmdlet Help Topic.
    <command:inputTypes> Agrega contenido para la sección de entradas del tema de ayuda del cmdlet.Adds content for the INPUTS section of the cmdlet Help topic. Para obtener más información, vea el tema de ayuda agregar tipos de entrada a un cmdlet.For more information, see How to Add Input Types to a Cmdlet Help Topic.
    <command:returnValues> Agrega contenido para la sección de resultados del tema de ayuda del cmdlet.Adds content for the OUTPUTS section of the cmdlet Help topic. Para obtener más información, vea el tema de ayuda cómo agregar valores devueltos a un cmdlet.For more information, see How to Add Return Values to a Cmdlet Help Topic.
    <maml:alertset> Agrega contenido a la sección Notas del tema de ayuda del cmdlet.Adds content for the NOTES section of the cmdlet Help topic. Para obtener más información, consulte el tema de ayuda agregar notas a un cmdlet.For more information, see How to add Notes to a Cmdlet Help Topic.
    <command:examples> Agrega contenido para la sección de ejemplos del tema de ayuda del cmdlet.Adds content for the EXAMPLES section of the cmdlet Help topic. Para obtener más información, consulte el tema de ayuda agregar ejemplos a un cmdlet.For more information, see How to Add Examples to a Cmdlet Help Topic.
    <maml:relatedLinks> Agrega el contenido de la sección vínculos relacionados del tema de ayuda del cmdlet.Adds content for the RELATED LINKS section of the cmdlet Help topic. Para obtener más información, vea Cómo agregar vínculos relacionados a un tema de ayuda de cmdlet.For more information, see How to Add Related Links to a Cmdlet Help Topic.

EjemploExample

Este es un ejemplo de un nodo de comando que incluye los nodos de las distintas secciones del tema de ayuda del cmdlet.Here is an example of a Command node that includes the nodes for the various sections of the cmdlet Help topic.

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

Consulte tambiénSee Also

Cómo agregar el nombre y la Sinopsis del cmdletHow to Add the Cmdlet Name and Synopsis

Cómo agregar la descripción detallada a un tema de ayuda de cmdletHow to Add the Detailed Description to a Cmdlet Help Topic

Cómo agregar una sintaxis a un tema de Ayuda del cmdletHow to Add Syntax to a Cmdlet Help Topic

Cómo agregar parámetros a un tema de ayuda de cmdletHow to Add Parameters to a Cmdlet Help Topic

Cómo agregar tipos de entrada a un tema de Ayuda del cmdletHow to Add Input Types to a Cmdlet Help Topic

Cómo agregar valores devueltos a un tema de Ayuda del cmdletHow to Add Return Values to a Cmdlet Help Topic

Cómo agregar notas a un tema de ayuda de cmdletHow to add Notes to a Cmdlet Help Topic

Cómo agregar ejemplos a un tema de Ayuda del cmdletHow to Add Examples to a Cmdlet Help Topic

Cómo agregar vínculos relacionados a un tema de Ayuda del cmdletHow to Add Related Links to a Cmdlet Help Topic

Windows PowerShell SDKWindows PowerShell SDK