Mise en place de l’aide basée sur les commentaires dans les fonctions

Cette rubrique explique où placer l’aide basée sur les commentaires pour une fonction afin que l’applet de commande Get-Help associe la rubrique d’aide basée sur les commentaires à la fonction correcte.

Emplacement où placer Comment-Based aide pour une fonction

• Au début du corps de la fonction.

• À la fin du corps de la fonction.

• Avant le mot-clé Function. Lorsque la fonction se trouve dans un script ou un module de script, il ne peut pas y avoir plusieurs lignes vides entre la dernière ligne de l’aide basée sur les commentaires et le mot clé Function. Sinon, Get-Help associe l’aide au script, et non à la fonction.

Exemples de placement d’aide dans une fonction

Les exemples suivants montrent chacune des trois options de placement pour l’aide basée sur les commentaires pour une fonction.

Aide au début d’un corps de fonction

L’exemple suivant montre un commentaire basé sur le début d’un corps de fonction.

function MyProcess
{
    <#
       .DESCRIPTION
       The MyProcess function gets the Windows PowerShell process.
    #>

    Get-Process powershell
}

Aide à la fin d’un corps de fonction

L’exemple suivant montre la base de commentaires à la fin d’un corps de fonction.

function MyFunction
{
    Get-Process powershell

    <#
       .DESCRIPTION
       The MyProcess function gets the Windows PowerShell process.
    #>
}

Aide avant le mot clé de fonction

Les exemples suivants illustrent les commentaires basés sur la ligne avant le mot clé de fonction.

<#
    .DESCRIPTION
    The MyProcess function gets the Windows PowerShell process.
#>
function MyFunction { Get-Process powershell}