mots clés d’aide Comment-Based
Cette rubrique répertorie et décrit les mots clés dans l’aide basée sur les commentaires.
Mots clés dans Comment-Based Aide
Voici des mots clés d’aide basés sur des commentaires valides. Ils sont répertoriés dans l’ordre dans lequel ils apparaissent généralement dans une rubrique d’aide ainsi que leur utilisation prévue. Ces mots clés peuvent apparaître dans n’importe quel ordre dans l’aide basée sur les commentaires, et ils ne respectent pas la casse.
Notez que le mot clé .EXTERNALHELP est prioritaire sur tous les autres mots clés d’aide basés sur des commentaires.
Lorsque .EXTERNALHELP est présent, l’applet de commande Get-Help n’affiche pas d’aide basée sur les commentaires, même si elle ne trouve pas de fichier d’aide qui correspond à la valeur du mot clé.
.SYNOPSIS
Brève description de la fonction ou du script. Ce mot clé ne peut être utilisé qu’une seule fois dans chaque rubrique.
.DESCRIPTION
Description détaillée de la fonction ou du script. Ce mot clé ne peut être utilisé qu’une seule fois dans chaque rubrique.
.PARAMETER <Parameter-Name>
Description d’un paramètre. Vous pouvez inclure un mot clé .PARAMETER pour chaque paramètre dans la fonction ou le script.
Les mots clés .PARAMETER peuvent apparaître dans n’importe quel ordre dans le bloc de commentaires, mais l’ordre dans lequel les paramètres apparaissent dans l’instruction ou la déclaration de fonction Param détermine l’ordre dans lequel les paramètres apparaissent dans la rubrique d’aide. Pour modifier l’ordre des paramètres dans la rubrique d’aide, modifiez l’ordre des paramètres dans l’instruction ou la déclaration de fonction Param.
Vous pouvez également spécifier une description de paramètre en plaçant un commentaire dans l’instruction Param immédiatement avant le nom de la variable de paramètre. Si vous utilisez à la fois un commentaire d’instruction Param et un mot clé .PARAMETER, la description associée au mot clé .PARAMETER est utilisée et le commentaire de l’instruction Param est ignoré.
.EXAMPLE
Exemple de commande qui utilise la fonction ou le script, éventuellement suivi d’un exemple de sortie et d’une description. Répétez ce mot clé pour chaque exemple.
.INPUTS
Types d’objets Microsoft .NET Framework qui peuvent être redirigés vers la fonction ou le script. Vous pouvez également inclure une description des objets d’entrée.
.OUTPUTS
Type .NET Framework des objets retournés par l’applet de commande. Vous pouvez également inclure une description des objets retournés.
.NOTES
Informations supplémentaires sur la fonction ou le script.
.LINK
Nom d’une rubrique associée. Répétez ce mot clé pour chaque rubrique associée. Ce contenu apparaît dans la section Liens connexes de la rubrique d’aide.
Le contenu du mot clé .LINK peut également inclure un URI (Uniform Resource Identifier) dans une version en ligne de la même rubrique d’aide. La version en ligne s’ouvre lorsque vous utilisez le paramètre Online de Get-Help. L’URI doit commencer par « http » ou « https ».
.COMPONENT
Nom de la technologie ou de la fonctionnalité utilisée par la fonction ou le script, ou auquel elle est associée.
Le paramètre Component de Get-Help utilise cette valeur pour filtrer les résultats de recherche retournés par Get-Help.
.ROLE
Nom du rôle d’utilisateur pour la rubrique d’aide. Le paramètre Role de Get-Help utilise cette valeur pour filtrer les résultats de recherche retournés par Get-Help.
.FUNCTIONALITY
Mots clés qui décrivent l’utilisation prévue de la fonction. Le paramètre Functionality de Get-Help utilise cette valeur pour filtrer les résultats de recherche retournés par Get-Help.
.FORWARDHELPTARGETNAME <Command-Name>
Redirige vers la rubrique d’aide de la commande spécifiée. Vous pouvez rediriger les utilisateurs vers n’importe quelle rubrique d’aide, y compris les rubriques d’aide pour une fonction, un script, une applet de commande ou un fournisseur.
.FORWARDHELPCATEGORY <Category>
Spécifie la catégorie d’aide de l’élément dans .FORWARDHELPTARGETNAME. Utilisez ce mot clé pour éviter les conflits lorsqu’il existe des commandes portant le même nom.
Les valeurs valides sont les suivantes :
- Alias
- Applet de commande
- HelpFile
- Function
- Provider
- General
- FAQ
- Glossary
- ScriptCommand
- ExternalScript
- Filtre
- Tout
.REMOTEHELPRUNSPACE <PSSession-variable>
Spécifie une session qui contient la rubrique d’aide. Entrez une variable qui contient une session PSSession. Ce mot clé est utilisé par l’applet de commande Export-PSSession pour rechercher les rubriques d’aide pour les commandes exportées.
.EXTERNALHELP <XML Help File>
Spécifie le chemin d’accès et/ou le nom d’un fichier d’aide XML pour le script ou la fonction.
Le mot clé .EXTERNALHELP est requis lors de l’utilisation d’un fichier d’aide XML pour un script ou une fonction. Sans cela, Get-Help ne trouve pas de fichier d’aide pour la fonction ou le script.
Le mot clé .EXTERNALHELP est prioritaire sur tous les autres mots clés d’aide basés sur des commentaires. Lorsque .EXTERNALHELP est présent, l’applet de commande Get-Help n’affiche pas d’aide basée sur les commentaires, même si elle ne trouve pas de fichier d’aide qui correspond à la valeur du mot clé.
Lorsque la fonction est exportée par un module de script, la valeur de .EXTERNALHELP doit être un nom de fichier sans chemin d’accès.
Get-Help recherche le fichier dans un sous-répertoire spécifique aux paramètres régionaux du répertoire du module. Il n’existe aucune exigence pour le nom de fichier, mais une bonne pratique consiste à utiliser le format de nom de fichier suivant : <ScriptModule>.psm1-help.xml.
Lorsque la fonction n’est pas associée à un module, incluez un chemin d’accès et un nom de fichier dans la valeur du mot clé .EXTERNALHELP. Si le chemin d’accès spécifié au fichier XML contient des sous-répertoires spécifiques à la culture de l’interface utilisateur, Get-Help recherche les sous-répertoires de manière récursive pour un fichier XML portant le nom du script ou de la fonction conformément aux normes de secours linguistiques établies pour Windows, comme pour toutes les rubriques d’aide basées sur XML.
Pour plus d’informations sur le format de fichier d’aide XML de l’applet de commande, consultez Écriture de l’aide sur l’applet de commande Windows PowerShell.
