Outils pour utilisateurs

Outils du site


dev:powershell:integration_aide

Ceci est une ancienne révision du document !


:TODO:

PowerShell : Intégrer l'aide au code

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.

Aide intégrée aux fonctions

Tous les commentaires ne sont pas extraits pour la génération de l'aide de la fonction, il faut les placer :

  • En entête de la définition de la fonction ;
  • Sur la première ligne sous la signature de la fonction ;
  • Sur la dernière ligne avant la fermeture de la fonction.
<#
    .Description
    The MyProcess function gets the Windows PowerShell process.
#>
function MyFunction { Get-Process powershell}
function MyFunction
{
    Get-Process powershell
 
    <#
       .Description
       The MyProcess function gets the Windows PowerShell process.
    #>
}
function MyProcess
{
    <#
       .Description
       The MyProcess function gets the Windows PowerShell process.
    #>
 
    Get-Process powershell
}

Références

dev/powershell/integration_aide.1692612372.txt.gz · Dernière modification : 2023/08/21 10:06 de yoann