Créer une aide pour son script powershell

Salut,

Quand on veut faire un script propre avec un système d’aide cohérent pour qu’il puisse être réutilisé, une aide peut s’avérer précieuse.

Il suffit de mettre en place entre “<#” et “#>”  un descriptif du type de celui ci dessous.

Vous remarquerez différentes sections:

  • SYNOPSIS
  • DESCRIPTION
  • EXAMPLE
  • PARAMETER (parametre)

Et vous pouvez aussi rajouter:

  • NOTES
  • LINKS
Si vous rentrez ceci en début de script. Vous pourrez gràce à la commande ci dessous afficher une aide bien pratique pour les personnes qui vont utiliser votre magnifique script. 😉 En effet avec Get-Help comme pour toute commande powershell, vous pourrez faire joujou.
Comme ça, vous pourrez rendre un truc relativement propre pour les personnes qui suivent !

@+