Colocación de la Ayuda basada en comentarios en los scripts

En este tema se explica dónde colocar la ayuda basada en comentarios de un script para que el cmdlet Get-Help asocie el tema de ayuda basado en comentarios con scripts y no con ninguna función que pueda estar en el script.

Dónde colocar Comment-Based Ayuda para un script

• Al principio del archivo de script.

  La Ayuda de script solo puede ir precedida del script por comentarios y líneas en blanco.

• Al final del archivo de script.

  Si el primer elemento del cuerpo del script (después de la Ayuda) es una declaración de función, debe haber al menos dos líneas en blanco entre el final de la Ayuda del script y la declaración de función. De lo contrario, la Ayuda se interpreta como Ayuda para la función, no como Ayuda para el script.

Ejemplos de ubicación de ayuda en un script

En los ejemplos siguientes se muestra cada una de las opciones de selección de ubicación de la ayuda basada en comentarios para un script.

Ayuda al principio de un script

En el ejemplo siguiente se muestra el comentario basado en comentarios al principio de un script.

<#
.DESCRIPTION
This script performs a series of network connection tests.
#>

param [string]$ComputerName
...

Ayuda al final de un script

En el ejemplo siguiente se muestra el comentario basado en comentarios al final de un script.

...
function Ping { Test-Connection -ComputerName $ComputerName }

<#
.DESCRIPTION
This script performs a series of network connection tests.
#>