Syntaxe de l’aide basée sur les commentaires

Cette section décrit la syntaxe de l’aide basée sur les commentaires.

Diagramme de syntaxe

La syntaxe de l’aide basée sur les commentaires est la suivante :

# .< help keyword>
# <help content>

-ou -

<#
.< help keyword>
< help content>
#>

Description de la syntaxe

L’aide basée sur les commentaires est écrite sous la forme d’une série de commentaires. Vous pouvez taper un symbole de commentaire (#) avant chaque ligne de commentaires, ou vous pouvez utiliser les symboles <# et #> pour créer un bloc de commentaires. Toutes les lignes du bloc de commentaires sont interprétées comme des commentaires.

Chaque section de l’aide basée sur les commentaires est définie par un mot clé et chaque mot clé est précédé d’un point (.). Les mots clés peuvent apparaître dans n’importe quel ordre. Les noms de mots clés ne sont pas sensibles à la casse.

Un bloc de commentaires doit contenir au moins un mot clé d’aide. Certains mots clés, tels que .EXAMPLE, peuvent apparaître plusieurs fois dans le même bloc de commentaires. Le contenu d’aide de chaque mot clé commence sur la ligne après le mot clé et peut s’étendre sur plusieurs lignes.

Toutes les lignes d’une rubrique d’aide basée sur des commentaires doivent être contiguës. Si une rubrique d’aide basée sur des commentaires suit un commentaire qui ne fait pas partie de la rubrique d’aide, il doit y avoir au moins une ligne vide entre la dernière ligne de commentaire non-Aide et le début de l’aide basée sur les commentaires.

Par exemple, la rubrique d’aide basée sur les commentaires suivante contient le mot clé .DESCRIPTION et sa valeur, qui est une description d’une fonction ou d’un script.

<#
    .DESCRIPTION
    The Get-Function function displays the name and syntax of all functions in the session.
#>