Créer une aide pour son script powershell
Posted in Aide
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
<# .SYNOPSIS This script will install the Snare Agent and configure it to communicate with Syslog Server .DESCRIPTION This script will install, upgrade, reinstall or uninstall the Free SNARE Windows Agent to gather Eventlog to Syslog Server. You can install it without parameters, a default config is working. .PARAMETER Reinstall This switch is not mandatory, it permits to reinstall client with config file. .PARAMETER VerbosePreference This parameter will define the level of verbose. It's not mandatory and default value is "Continue" .EXAMPLE C:PS>.Script.ps1 C:PS>.Script.ps1 -verbosepreference Continue C:PS>.Script.ps1 -reinstall #>
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.
Get-Help C:testScript.ps1 Get-Help C:testScript.ps1 -examples Get-Help C:testScript.ps1 -detailed Get-Help C:testScript.ps1 -full
Comme ça, vous pourrez rendre un truc relativement propre pour les personnes qui suivent !
@+
