Sommaire

Aide intégrée aux scripts et fonctions

Lorsque l’on développe des fonctions ou des scripts qui doivent être utilisés par d’autres personnes que par nous-mêmes, comme par exemple dans le cadre du développement d’un module regroupant un ensemble de fonctions, il peut être très utile de fournir de l’aide.

Plutôt que d’écrire des tonnes de documentations sous forme de documents Word associés à nos modules, scripts ou fonctions, PowerShell offre une fonctionnalité extrêmement intéressante : la possibilité d’embarquer de l’aide soit directement dans le code, soit à l’extérieur sous forme de fichiers XML (respectant la grammaire MAML).

L’avantage de fournir de l’aide à nos scripts ou fonctions est que cela confère un caractère professionnel à notre travail, et ce avec un minimum d’efforts à fournir. En effet, les scripts ou fonctions disposant d’aide se comportent exactement comme les commandelettes natives. Les utilisateurs disposeront donc, à ce titre, pour chacune de vos réalisations, des trois niveaux de détails habituels, à savoir : l’aide standard, détaillée ou complète.

Reprenons pour illustrer nos propos la fonction Show-Popup étudiée précédemment.

Function Show-Popup  
{  
   param([string]$message=’Message...’, ...