Palabras clave de ayuda de Comment-Based

En este tema se enumeran y describen las palabras clave de la ayuda basada en comentarios.

Palabras clave en la Ayuda de Comment-Based

A continuación se muestran palabras clave de Ayuda basadas en comentarios válidas. Se muestran en el orden en que aparecen normalmente en un tema de Ayuda junto con su uso previsto. Estas palabras clave pueden aparecer en cualquier orden en la Ayuda basada en comentarios y no distinguen mayúsculas de minúsculas.

Tenga en cuenta que la palabra clave .EXTERNALHELP tiene prioridad sobre todas las demás palabras clave de ayuda basadas en comentarios. Cuando .EXTERNALHELP está presente, el cmdlet Get-Help no muestra ayuda basada en comentarios, incluso cuando no puede encontrar un archivo de ayuda que coincida con el valor de la palabra clave.

.SYNOPSIS

Una breve descripción de la función o script. Esta palabra clave solo se puede usar una vez en cada tema.

.DESCRIPTION

Descripción detallada de la función o script. Esta palabra clave solo se puede usar una vez en cada tema.

.PARAMETER <Parameter-Name>

Descripción de un parámetro. Puede incluir una palabra clave .PARAMETER para cada parámetro de la función o script.

Las palabras clave .PARAMETER pueden aparecer en cualquier orden del bloque de comentarios, pero el orden en el que aparecen los parámetros en la instrucción o declaración de función de param determina el orden en el que aparecen los parámetros en el tema de Ayuda. Para cambiar el orden de los parámetros en el tema de Ayuda, cambie el orden de los parámetros en la instrucción param o declaración de función.

También puede especificar una descripción de parámetro colocando un comentario en la instrucción param inmediatamente antes del nombre de la variable de parámetro. Si usa un comentario de instrucción param y una palabra clave .PARAMETER, se usa la descripción asociada a la palabra clave .PARAMETER y se omite el comentario de la instrucción param.

.EXAMPLE

Comando de ejemplo que usa la función o el script, seguido opcionalmente de la salida de ejemplo y una descripción. Repita esta palabra clave para cada ejemplo.

.INPUTS

Los tipos de objetos .NET que se pueden canalizar a la función o script. También puede incluir una descripción de los objetos de entrada. Repita esta palabra clave para cada tipo de entrada.

.OUTPUTS

Tipo de .NET de los objetos que devuelve el cmdlet. También puede incluir una descripción de los objetos devueltos. Repita esta palabra clave para cada tipo de salida.

.NOTES

Información adicional sobre la función o el script.

.LINK

Nombre de un tema relacionado. Repita esta palabra clave para cada tema relacionado. Este contenido aparece en la sección Vínculos relacionados del tema de Ayuda.

El contenido de la palabra clave .LINK también puede incluir un identificador uniforme de recursos (URI) en una versión en línea del mismo tema de ayuda. La versión en línea se abre cuando se utiliza el parámetro En línea de Get-Help. El URI debe comenzar por http o https.

.COMPONENT

Nombre de la tecnología o característica que usa la función o el script, o a la que está relacionado. El parámetro Component de Get-Help usa este valor para filtrar los resultados de búsqueda devueltos por Get-Help.

.ROLE

Nombre del rol de usuario para el tema de ayuda. El parámetro Role de Get-Help usa este valor para filtrar los resultados de búsqueda devueltos por Get-Help.

.FUNCTIONALITY

Palabras clave que describen el uso previsto de la función. El parámetro Functionality de Get-Help usa este valor para filtrar los resultados de búsqueda devueltos por Get-Help.

.FORWARDHELPTARGETNAME <Command-Name>

Redirige al tema de ayuda del comando especificado. Puede redirigir a los usuarios a cualquier tema de ayuda, incluido el contenido de ayuda de una función, un script, un cmdlet o un proveedor.

# .FORWARDHELPTARGETNAME <Command-Name>

.FORWARDHELPCATEGORY

Especifica la categoría de ayuda del elemento en .FORWARDHELPTARGETNAME. Los valores válidos son Alias, Cmdlet, HelpFile, Function, Provider, General, FAQ, Glossary, ScriptCommand, ExternalScript, Filtero All. Use esta palabra clave para evitar conflictos cuando haya comandos con el mismo nombre.

# .FORWARDHELPCATEGORY <Category>

.REMOTEHELPRUNSPACE <PSSession-variable>

Especifica una sesión que contiene el tema de ayuda. Escriba una variable que contenga un objeto de PSSession. El cmdlet [Export-PSSession][09] usa esta palabra clave para buscar el contenido de ayuda de los comandos exportados.

# .REMOTEHELPRUNSPACE <PSSession-variable>

.EXTERNALHELP

Especifica un archivo de ayuda basado en XML para el script o la función.

# .EXTERNALHELP <XML Help File>

La palabra clave .EXTERNALHELP es necesaria cuando una función o script se documenta en archivos XML. Sin esta palabra clave, Get-Help no puede encontrar el archivo de ayuda basado en XML para la función o script.

La palabra clave .EXTERNALHELP tiene prioridad sobre otras palabras clave de ayuda basadas en comentarios. Si .EXTERNALHELP está presente, Get-Help no muestra la ayuda basada en comentarios, aunque no encuentre un tema de ayuda que coincida con el valor de la palabra clave .EXTERNALHELP.

Si un módulo exporta la función, establezca el valor de la palabra clave .EXTERNALHELP en un nombre de archivo sin una ruta de acceso. Get-Help busca el nombre de archivo especificado en un subdirectorio específico del lenguaje del directorio del módulo. No hay ningún requisito para el nombre del archivo de ayuda basado en XML para una función. A partir de PowerShell 5.0, las funciones exportadas por un módulo se pueden documentar en un archivo de ayuda denominado para el módulo. No es necesario usar .EXTERNALHELP la palabra clave comment. Por ejemplo, si el MyModule módulo exporta la Test-Function función, puede asignar un nombre al archivo MyModule-help.xmlde ayuda . El Get-Help cmdlet busca ayuda para la Test-Function función en el MyModule-help.xml archivo del directorio del módulo.

Si la función no está incluida en un módulo, incluya una ruta de acceso al archivo de ayuda basado en XML. Si el valor incluye una ruta y la ruta contiene subdirectorios específicos de la cultura de la interfaz de usuario, Get-Help busca recursivamente en los subdirectorios un archivo XML con el nombre del script o función de acuerdo con las normas de retroceso de idioma establecidas para Windows, al igual que hace en un directorio de módulos.

Para obtener más información sobre el formato de archivo de ayuda basado en XML del cmdlet, consulte How to Write Cmdlet Help.