Palabras clave de ayuda basadas en comentarios

Este tema enumera y describe las palabras clave en la ayuda basada en comentarios.

Palabras clave en la ayuda basada en comentarios

Las siguientes son palabras clave válidas de ayuda basadas en comentarios. Se enumeran en el orden en que suelen aparecer 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 entre mayúsculas y 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.

.SINOPSIS

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

.DESCRIPCIÓN

Una descripción detallada de la función o script. Esta palabra clave se puede utilizar sólo una vez en cada tema.

.PARAMETER

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

Las palabras clave .PARAMETER pueden aparecer en cualquier orden en el bloque de comentarios, pero el orden en el que aparecen los parámetros en la declaración Param o en la declaración de función determina el orden en el que aparecen los parámetros. aparecen 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 declaración Param o en la 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 del parámetro. Si utiliza un comentario de declaración Param y una palabra clave .PARAMETER, se utiliza la descripción asociada con la palabra clave .PARAMETER y la palabra clave .PARAMETER. El comentario de la declaración >Param se ignora.

.EJEMPLO

Un comando de muestra que utiliza la función o secuencia de comandos, seguido opcionalmente de un resultado de muestra y una descripción. Repita esta palabra clave para cada ejemplo.

.ENTRADA

Los tipos de objetos de Microsoft .NET Framework que se pueden canalizar a la función o secuencia de comandos. También puede incluir una descripción de los objetos de entrada.

.SALIDAS

El tipo .NET Framework de los objetos que devuelve el cmdlet. También puede incluir una descripción de los objetos devueltos.

.NOTAS

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

.LINK

El nombre de un tema relacionado. Repita esta palabra clave para cada tema relacionado. Este contenido aparece en la sección Enlaces relacionados del tema de Ayuda.

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

.COMPONENT

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

.ROLE

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

.FUNCIONALIDAD

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

.FORWARDHELPTARGETNAME

Redirecciona al tema de Ayuda para el comando especificado. Puede redirigir a los usuarios a cualquier tema de Ayuda, incluidos temas de Ayuda para una función, script, cmdlet o proveedor.

.FORWARDHELPCATEGORY

Especifica la categoría de Ayuda del elemento en .FORWARDHELPTARGETNAME. Utilice esta palabra clave para evitar conflictos cuando haya comandos con el mismo nombre.

Los valores válidos son:

• Alias
• cmdlet
• HelpFile
• Función
• Proveedor
• General
• Preguntas frecuentes
• Glosario
• ScriptCommand
• ExternalScript
• Filtrar
• Todo

.REMOTEHELPRUNSPACE

Especifica una sesión que contiene el tema de Ayuda. Introduzca una variable que contenga una PSSession. El cmdlet Export-PSSession utiliza esta palabra clave para buscar los temas de ayuda para los comandos exportados.

.EXTERNALHELP

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

La palabra clave .EXTERNALHELP le indica al cmdlet Get-Help que obtenga ayuda para el script o función en un archivo basado en XML. La palabra clave .EXTERNALHELP es necesaria cuando se utiliza un archivo de ayuda basado en XML para un script o función. Sin él, 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 la función se exporta mediante un módulo de script, el valor de .EXTERNALHELP debe ser un nombre de archivo sin ruta. Get-Help busca el archivo en un subdirectorio específico de la configuración regional del directorio del módulo. No hay requisitos para el nombre del archivo, pero una práctica recomendada es utilizar el siguiente formato de nombre de archivo: <ScriptModule>.psm1-help.xml.

Cuando la función no esté asociada con un módulo, incluya una ruta y un nombre de archivo en el valor de la palabra clave .EXTERNALHELP. Si la ruta especificada al archivo XML contiene subdirectorios específicos de la cultura de la interfaz de usuario, Get-Help busca en los subdirectorios de forma recursiva un archivo XML con el nombre del script o función de acuerdo con los estándares de lenguaje alternativo establecidos. para Windows, tal como ocurre con todos los temas de Ayuda basados en XML.

Para obtener más información sobre el formato de archivo de ayuda basado en XML de la ayuda del cmdlet, consulte Escritura de la ayuda del cmdlet de Windows PowerShell.