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 de Microsoft .NET Framework que se pueden canalizar a la función o script. También puede incluir una descripción de los objetos de entrada.
.OUTPUTS
Tipo de .NET Framework de los objetos que devuelve el cmdlet. También puede incluir una descripción de los objetos devueltos.
.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 usa el parámetro Online de Get-Help. El URI debe comenzar con "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, incluidos los temas de Ayuda para una función, un script, un cmdlet o un proveedor.
.FORWARDHELPCATEGORY <Category>
Especifica la categoría Ayuda del elemento en .FORWARDHELPTARGETNAME. Use esta palabra clave para evitar conflictos cuando haya comandos con el mismo nombre.
Los valores válidos son:
- Alias
- Cmdlet
- HelpFile
- Function
- Provider
- General
- FAQ
- Glossary
- ScriptCommand
- ExternalScript
- Filtro
- Todo
.REMOTEHELPRUNSPACE <PSSession-variable>
Especifica una sesión que contiene el tema de Ayuda. Escriba una variable que contenga una PSSession. El cmdlet Export-PSSession usa esta palabra clave para buscar los temas de Ayuda de los comandos exportados.
.EXTERNALHELP <XML Help File>
Especifica la ruta de acceso o el nombre de un archivo de ayuda basado en XML para el script o la función.
La palabra clave .EXTERNALHELP es necesaria cuando se usa un archivo de ayuda basado en XML para un script o función. Sin ella, Get-Help no encontrará un archivo de ayuda para la función o script.
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.
Cuando un módulo de script exporta la función, el valor de .EXTERNALHELP debe ser un nombre de archivo sin una ruta de acceso.
Get-Help busca el archivo en un subdirectorio específico de la configuración regional del directorio del módulo. No hay ningún requisito para el nombre de archivo, pero un procedimiento recomendado es usar el siguiente formato de nombre de archivo: <ScriptModule>.psm1-help.xml.
Cuando la función no está asociada a un módulo, incluya una ruta de acceso y un nombre de archivo en el valor de la palabra clave .EXTERNALHELP. Si la ruta de acceso especificada al archivo XML contiene subdirectorios específicos de la referencia cultural de la interfaz de usuario, Get-Help busca de forma recursiva los subdirectorios de un archivo XML con el nombre del script o la función de acuerdo con los estándares de reserva de lenguaje establecidos para Windows, igual que para todos los temas de Ayuda basados en XML.
Para obtener más información sobre el formato de archivo de ayuda basado en XML del cmdlet, consulte Escritura de la Ayuda del cmdlet de Windows PowerShell.
