Ceci est une ancienne révision du document !
La cmdlet Get-Help peut extraire les commentaires présents dans les scripts (module et les fonctions) et générer / mettre en forme l'aide. La documentation officielle désigne cela par aide basée sur les commentaires.
Tous les commentaires ne sont pas extraits pour la génération de l'aide basée sur les commentaires. Dans le cas d'une fonction il faut les placer :
<# .Description The MyProcess function gets the Windows PowerShell process. #> function MyFunction { Get-Process powershell}
function MyProcess { <# .Description The MyProcess function gets the Windows PowerShell process. #> Get-Process powershell }
function MyFunction { Get-Process powershell <# .Description The MyProcess function gets the Windows PowerShell process. #> }
Le bloc de commentaires utilisés pour la génération de l'aide contiennent des mots clés commençant par un .. Ni l'ordre d’apparition, ni la casse de caractères n'a d'importance.
Quelques mots clés usuels :
.SYNOPSIS | Description courte, ne s'utilise qu'une fois par rubrique. |
---|---|
.DESCRIPTION | Description détaillée, ne s'utilise qu'une fois par rubrique. |
.PARAMETER | Description d'un paramètre. |
.EXAMPLE | Exemple d'utilisation/appel de la fonction ou du script. |
.LINK | Associer une ou plusieurs rubrique d'aide ou Uri |