Sintaxis de la Ayuda basada en comentarios

En esta sección se describe la sintaxis de la ayuda basada en comentarios.

Diagrama de sintaxis

La sintaxis de la Ayuda basada en comentarios es la siguiente:

# .< help keyword>
# <help content>

O bien

<#
.< help keyword>
< help content>
#>

Descripción de la sintaxis

La Ayuda basada en comentarios se escribe como una serie de comentarios. Puede escribir un símbolo de comentario (#) antes de cada línea de comentarios, o puede usar los símbolos <# y #> para crear un bloque de comentarios. Todas las líneas del bloque de comentarios se interpretan como comentarios.

Cada sección de la Ayuda basada en comentarios se define mediante una palabra clave y cada palabra clave va precedida de un punto (.). Las palabras clave pueden aparecer en cualquier orden. Los nombres de palabra clave no distinguen mayúsculas de minúsculas.

Un bloque de comentarios debe contener al menos una palabra clave de ayuda. Algunas de las palabras clave, como .EXAMPLE, pueden aparecer muchas veces en el mismo bloque de comentarios. El contenido de ayuda de cada palabra clave comienza en la línea después de la palabra clave y puede abarcar varias líneas.

Todas las líneas de un tema de Ayuda basado en comentarios deben ser contiguas. Si un tema de Ayuda basado en comentarios sigue un comentario que no forma parte del tema de Ayuda, debe haber al menos una línea en blanco entre la última línea de comentarios que no sea de Ayuda y el principio de la Ayuda basada en comentarios.

Por ejemplo, el siguiente tema de ayuda basado en comentarios contiene la palabra clave .DESCRIPTION y su valor, que es una descripción de una función o script.

<#
    .DESCRIPTION
    The Get-Function function displays the name and syntax of all functions in the session.
#>