Mise en place de l’aide basée sur les commentaires dans les scripts

Cette rubrique explique où placer l’aide basée sur les commentaires pour un script afin que l’applet de commande Get-Help associe la rubrique d’aide basée sur les commentaires aux scripts et non à des fonctions qui peuvent se trouver dans le script.

Emplacement où placer Comment-Based aide pour un script

• Au début du fichier de script.

  L’aide du script peut être précédée du script uniquement par des commentaires et des lignes vides.

• À la fin du fichier de script.

  Si le premier élément du corps du script (après l’aide) est une déclaration de fonction, il doit y avoir au moins deux lignes vides entre la fin du script Help et la déclaration de fonction. Sinon, l’aide est interprétée comme l’aide pour la fonction, et non l’aide pour le script.

Exemples de placement d’aide dans un script

Les exemples suivants montrent chacune des options de placement pour l’aide basée sur les commentaires pour un script.

Aide au début d’un script

L’exemple suivant montre les commentaires au début d’un script.

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

param [string]$ComputerName
...

Aide à la fin d’un script

L’exemple suivant montre la base de commentaires à la fin d’un script.

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

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