about_Comment_Based_Help
Mis à jour: mai 2014
S'applique à: Windows PowerShell 2.0, Windows PowerShell 3.0, Windows PowerShell 4.0, Windows PowerShell 5.0
Insérez l'introduction ici.
RUBRIQUE
about_Comment_Based_Help
DESCRIPTION COURTE
Explique comment écrire des rubriques d’aide basées sur les commentaires pour les fonctions et les scripts.
DESCRIPTION DÉTAILLÉE
Vous pouvez écrire des rubriques d’aide basées sur les commentaires pour les fonctions et les scripts en utilisant des mots clés de commentaires d’aide spéciaux.
L’applet de commande Get-Help affiche l’aide basée sur les commentaires au même format que celui dans lequel elle affiche les rubriques d’aide générées à partir de fichiers XML. Les utilisateurs peuvent utiliser tous les paramètres de Get-Help, comme Detailed, Full, Example et Online, pour afficher le contenu de l’aide basée sur les commentaires.
Vous pouvez également écrire des fichiers d’aide XML pour les fonctions et les scripts. Pour permettre à l’applet de commande Get-Help de trouver le fichier d’aide XML pour une fonction ou un script, utilisez le mot clé ExternalHelp. Sans ce mot clé, Get-Help ne peut pas trouver les rubriques d’aide XML pour les fonctions ou les scripts.
Cette rubrique explique comment écrire des rubriques d’aide pour les fonctions et les scripts. Pour plus d’informations sur l’affichage des rubriques d’aide pour les fonctions et les scripts, voir Get-Help.
REMARQUE :
Les applets de commande Update-Help et Save-Help fonctionnent seulement sur les fichiers XML. L’aide actualisable ne prend pas en charge les rubriques d’aide basées sur les commentaires.
REMARQUE SUR LA RÉSOLUTION DES PROBLÈMES :
Les valeurs par défaut et une valeur pour « Accepter les caractères génériques » n’apparaissent pas dans le tableau d’attributs de paramètre, même quand elles sont définies dans la fonction ou dans le script. Pour aider les utilisateurs, spécifiez ces informations dans la description du paramètre.
SYNTAXE DE L’AIDE BASÉE SUR LES COMMENTAIRES
La syntaxe pour l’aide basée sur les commentaires est la suivante :
# .< help keyword>
# <help content>
-or -
<#
.< help keyword>
< help content>
#>
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 (#) devant chaque ligne de commentaires, ou vous pouvez utiliser les symboles « <# » et « #> » pour créer un bloc de commentaires. Toutes les lignes qui se trouvent dans le bloc de commentaires sont interprétées comme des commentaires.
Toutes les lignes d’une rubrique d’aide basée sur les commentaires doivent être contiguës. Si une rubrique d’aide basée sur les 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 qui ne fait pas partie de l’aide et le début de l’aide basée sur les commentaires.
Des mots clés définissent chaque section de l’aide basée sur les commentaires. Chaque mot clé de l’aide basée sur les commentaires est précédé d’un point (.). Les mots clés peuvent apparaître dans n’importe quel ordre. Les noms des mots clés ne respectent pas la casse.
Par exemple, le mot clé Description précède une description d’une fonction ou d’un script.
<#
.Description
Get-Function displays the name and syntax of all functions in the session.
#>
Le bloc de commentaires doit contenir au moins un mot clé. Certains mots clés, comme EXAMPLE, peuvent apparaître plusieurs fois dans le même bloc de commentaires. Le contenu de l’aide pour chaque mot clé commence sur la ligne située après le mot clé et peut s’étendre sur plusieurs lignes.
SYNTAXE POUR L’AIDE BASÉE SUR LES COMMENTAIRES DANS LES FONCTIONS
L’aide basée sur les commentaires pour une fonction peut apparaître dans un des trois emplacements suivants :
-- At the beginning of the function body.
-- At the end of the function body.
-- Before the Function keyword. There cannot be more than one blank
line between the last line of the function help and the Function
keyword.
Exemple :
function Get-Function
{
<#
.< help keyword>
< help content>
#>
<function commands>
}
-or -
function Get-Function
{
<function commands>
<#
.< help keyword>
< help content>
#>
}
-or -
<#
.< help keyword>
< help content>
#>
function Get-Function { }
SYNTAXE POUR L’AIDE BASÉE SUR LES COMMENTAIRES DANS LES SCRIPTS
L’aide basée sur les commentaires pour un script peut apparaître dans un des deux emplacements suivants dans le script.
-- At the beginning of the script file. Script help can be preceded in the
script only by comments and blank lines.
-- If the first item in the script body (after the help) is a function
declaration, there must be at least two blank lines between the end of the
script help and the function declaration. Otherwise, the help is
interpreted as being help for the function, not help for the script.
-- At the end of the script file. However, if the script is signed, place
Comment-based help at the beginning of the script file. The end of the
script is occupied by the signature block.
Exemple :
<#
.< help keyword>
< help content>
#>
function Get-Function { }
-or-
function Get-Function { }
<#
.< help keyword>
< help content>
#>
SYNTAXE POUR L’AIDE BASÉE SUR LES COMMENTAIRES DANS LES MODULES DE SCRIPTS
Dans un module de script (.psm1), l’aide basée sur les commentaires utilise la syntaxe pour les fonctions, et non pas la syntaxe pour les scripts. Vous ne pouvez pas utiliser la syntaxe des scripts pour fournir une aide pour toutes les fonctions définies dans un module de script.
Par exemple, si vous utilisez le mot clé ExternalHelp pour identifier les fichiers d’aide XML pour les fonctions dans un module de script, vous devez ajouter un commentaire ExternalHelp à chaque fonction.
# .ExternalHelp <XML-file-name>
function <function-name>
{
...
}
MOTS CLÉS DE L’AIDE BASÉE SUR LES COMMENTAIRES
Voici les mots clés valides de l’aide basée sur les commentaires. Ils figurent dans l’ordre où ils apparaissent généralement dans une rubrique d’aide, avec 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.
.SYNOPSIS
Une brève description de la fonction ou du script. Ce mot clé peut être utilisé une seule fois dans chaque rubrique.
.DESCRIPTION
Une description détaillée de la fonction ou du script. Ce mot clé peut être utilisé une seule fois dans chaque rubrique.
.PARAMETER <Nom-paramètre>
La description d’un paramètre. Ajoutez un mot clé .PARAMETER pour chaque paramètre dans la syntaxe de la fonction ou du script.
Tapez le nom du paramètre sur la même ligne que le mot clé PARAMETER. Tapez la description du paramètre sur les lignes qui suivent le mot clé PARAMETER. Windows PowerShell interprète tout le texte entre le mot clé .PARAMETER et le mot clé suivant ou la fin du bloc de commentaires comme faisant partie de la description du paramètre. La description peut inclure des sauts de paragraphe.
Les mots clés Parameter peuvent apparaître dans n’importe quel ordre dans le bloc de commentaires, mais la syntaxe de la fonction ou du script détermine l’ordre dans lequel les paramètres (et leurs descriptions) apparaissent dans la rubrique d’aide. Pour changer l’ordre, changez la syntaxe.
Vous pouvez également spécifier une description du paramètre en plaçant un commentaire dans la syntaxe de la fonction ou du script immédiatement avant le nom de la variable de paramètre. Si vous utilisez à la fois un commentaire de syntaxe et un mot clé Parameter, la description associée au mot clé Parameter est utilisée, et le commentaire de syntaxe est ignoré.
.EXAMPLE
Un 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
Les types Microsoft .NET Framework des objets qui peuvent être redirigés vers la fonction ou le script. Vous pouvez également inclure une description des objets d’entrée.
.OUTPUTS
Le type .NET Framework des objets que l’applet de commande retourne. Vous pouvez également inclure une description des objets retournés.
.NOTES
Informations supplémentaires sur la fonction ou le script.
.LINK
Le nom d’une rubrique connexe. La valeur figure sur la ligne en dessous du mot clé .LINK, et elle doit être précédée d’un symbole de commentaire (#) ou incluse dans le bloc de commentaires.
Répétez le mot clé .LINK pour chaque rubrique connexe.
Ce contenu s’affiche dans la section Liens connexes de la rubrique d’aide.
Le contenu du mot clé Link peut également inclure un URI (Uniform Resource Identifier) vers une version en ligne de la même rubrique d’aide. La version en ligne s’ouvre quand vous utilisez le paramètre Online de Get-Help. L’URI doit commencer par « http » ou par « https ».
.COMPONENT
La technologie ou la fonctionnalité que la fonction ou le script utilise, ou à laquelle il est associé. Ce contenu s’affiche quand la commande Get-Help inclut le paramètre Component de Get-Help.
.ROLE
Le rôle d’utilisateur pour la rubrique d’aide. Ce contenu s’affiche quand la commande Get-Help inclut le paramètre Role de Get-Help.
.FUNCTIONALITY
L’utilisation prévue de la fonction. Ce contenu s’affiche quand la commande Get-Help inclut le paramètre Functionality de Get-Help.
.FORWARDHELPTARGETNAME <Nom-commande>
Effectue une redirection vers la rubrique d’aide pour la commande spécifiée. Vous pouvez rediriger les utilisateurs vers n’importe quelle rubrique d’aide, y compris des rubriques d’aide pour une fonction, un script, une applet de commande ou un fournisseur.
.FORWARDHELPCATEGORY <Catégorie>
Spécifie la catégorie de l’aide de l’élément dans ForwardHelpTargetName. Les valeurs valides sont Alias, Cmdlet, HelpFile, Function, Provider, General, FAQ, Glossary, ScriptCommand, ExternalScript, Filter ou All. Utilisez ce mot clé pour éviter les conflits quand des commandes portent le même nom.
.REMOTEHELPRUNSPACE <Variable-Session PowerShell>
Spécifie une session qui contient la rubrique d’aide. Entrez une variable qui contient une session PowerShell. Ce mot clé est utilisé par l’applet de commande Export-PSSession pour rechercher les rubriques d’aide pour les commandes exportés.
.EXTERNALHELP <Fichier d’aide XML>
Spécifie un fichier d’aide XML pour le script ou la fonction.
Le mot clé ExternalHelp est requis quand une fonction ou un script est documenté dans des fichiers XML. Sans ce mot clé, Get-Help ne peut pas trouver le fichier d’aide XML pour la fonction ou le script.
Le mot clé ExternalHelp est prioritaire sur les autres mots clés de l’aide basée sur les commentaires. Si ExternalHelp est présent, Get-Help n’affiche pas d’aide basée sur les commentaires, même si elle ne peut pas trouver une rubrique d’aide qui correspond à la valeur du mot clé ExternalHelp.
Si la fonction est exportée par un module, définissez la valeur du mot clé ExternalHelp sur un nom de fichier sans chemin d’accès. Get-Help recherche le nom de fichier spécifié dans un sous-répertoire spécifique à une langue du répertoire du module. Il n’existe aucune condition requise pour le nom du fichier d’aide XML pour une fonction, mais c’est une meilleure pratique d’utiliser le format suivant :
<ScriptModule.psm1>-help.xml
Si la fonction n’est pas incluse dans un module, incluez un chemin d’accès du fichier d’aide XML. Si la valeur inclut un chemin d’accès et que le chemin d’accès contient des sous-répertoires spécifiques à une culture pour l’interface utilisateur, Get-Help recherche de manière récursive dans les sous-répertoires un fichier XML avec le nom du script ou de la fonction selon les normes en matière de langue de base établies pour Windows, comme il le fait dans un répertoire de module.
Pour plus d’informations sur le format des fichiers d’aide XML pour l’aide des applets de commande, consultez « Comment créer l’aide des applets de commande » dans la bibliothèque MSDN (Microsoft Developer Network) à l’adresse https://go.microsoft.com/fwlink/?LinkID=123415.
CONTENU GÉNÉRÉ AUTOMATIQUEMENT
Le nom, la syntaxe, la liste de paramètres, le tableau d’attributs de paramètre, les paramètres communs et les remarques sont automatiquement générés par l’applet de commande Get-Help.
Nom :
La section Name d’une rubrique d’aide d’une fonction provient du nom de la fonction dans la syntaxe de la fonction. Le nom d’une rubrique d’aide d’un script provient du nom du fichier de script. Pour modifier le nom ou sa casse, modifiez la syntaxe de la fonction ou le nom du fichier de script.
Syntaxe :
La section Syntax de la rubrique d’aide est générée à partir de la syntaxe de la fonction ou du script. Pour ajouter des détails à la syntaxe de la rubrique d’aide, comme .NET Framework d’un paramètre, ajoutez le détail à la syntaxe. Si vous ne spécifiez pas le type d’un paramètre, le type « Object » est inséré comme valeur par défaut.
Liste des paramètres :
La liste des paramètres de la rubrique d’aide est générée à partir de la syntaxe de la fonction ou du script, ainsi que de la description que vous ajoutez à l’aide du mot clé Parameters. Les paramètres d’une fonction apparaissent dans la section « Parameters » de la rubrique d’aide, dans l’ordre où ils apparaissent dans la syntaxe de la fonction ou du script. L’orthographe et la casse des noms des paramètres proviennent également de la syntaxe ; ils ne sont pas affectés par le nom du paramètre spécifié par le mot clé Parameter.
Paramètres communs :
Les paramètres communs sont ajoutés à la syntaxe et à la liste des paramètres de la rubrique d’aide, même s’ils n’ont aucun effet. Pour plus d’informations sur les paramètres communs, consultez about_CommonParameters.
Tableau des attributs de paramètre :
Get-Help génère le tableau des attributs de paramètre qui apparaît quand vous utilisez le paramètre Full ou Parameter de Get-Help. La valeur des attributs Required, Position et Default value provient de la syntaxe de la fonction ou du script.
REMARQUE SUR LA RÉSOLUTION DES PROBLÈMES :
Les valeurs par défaut n’apparaissent pas dans la table des attributs de paramètre, même quand ils sont définis dans la fonction ou dans le script. Pour aider les utilisateurs, spécifiez la valeur par défaut dans la description du paramètre.
Remarques :
La section Remarks de la rubrique d’aide est générée automatiquement à partir du nom de la fonction ou du script. Vous ne pouvez pas modifier ou déterminer son contenu.
DÉSACTIVATION DE L’AIDE BASÉE SUR LES COMMENTAIRES
[Cette technique a été suggérée par Rich Prescott, un ingénieur Windows de New York, NY.]
Vous pouvez désactiver l’aide basée sur les commentaires. Cela rend l’aide basée sur les commentaires inactive sans la supprimer.
Pour désactiver l’aide basée sur les commentaires, placez les commentaires dans une here-string. Pour masquer here-string, affectez-la à une variable ou redirigez-la vers l’applet de commande Out-Null.
Quand elle est désactivée, l’aide basée sur les commentaires n’a aucun effet.
Par exemple, la fonction suivante a une aide basée sur les commentaires.
<#
.SYNOPSIS
Adds a file name extension to a supplied name.
#>
function Add-Extension
{
param ([string]$Name,[string]$Extension = "txt")
...
}
Pour désactiver l’aide basée sur les commentaires, placez-la dans une here-string, comme illustré dans l’exemple suivant.
@"
<#
.SYNOPSIS
Adds a file name extension to a supplied name.
#>
"@
function Add-Extension
{
param ([string]$Name,[string]$Extension = "txt")
...
}
Pour masquer l’aide basée sur les commentaires désactivée, affectez la here-string à une variable locale qui n’est pas utilisée dans la fonction, comme illustré dans l’exemple suivant. Vous pouvez également la rediriger vers l’applet de commande Out-Null.
$x = @"
<#
.SYNOPSIS
Adds a file name extension to a supplied name.
#>
"@
function Add-Extension
{
param ([string]$Name,[string]$Extension = "txt")
...
}
Pour plus d’informations sur les chaînes here-string, consultez about_Quoting_Rules (https://go.microsoft.com/fwlink/?LinkID=113253).
EXEMPLES
Exemple 1 : Aide basée sur les commentaires pour une fonction
L’exemple de fonction suivant inclut une aide basée sur les commentaires :
function Add-Extension
{
param ([string]$Name,[string]$Extension = "txt")
$name = $name + "." + $extension
$name
<#
.SYNOPSIS
Adds a file name extension to a supplied name.
.DESCRIPTION
Adds a file name extension to a supplied name.
Takes any strings for the file name or extension.
.PARAMETER Name
Specifies the file name.
.PARAMETER Extension
Specifies the extension. "Txt" is the default.
.INPUTS
None. You cannot pipe objects to Add-Extension.
.OUTPUTS
System.String. Add-Extension returns a string with the extension or file name.
.EXAMPLE
C:\PS> extension -name "File"
File.txt
.EXAMPLE
C:\PS> extension -name "File" -extension "doc"
File.doc
.EXAMPLE
C:\PS> extension "File" "doc"
File.doc
.LINK
http://www.fabrikam.com/extension.html
.LINK
Set-Item
#>
}
Les résultats sont les suivants :
C:\PS> get-help add-extension -full
NAME
Add-Extension
SYNOPSIS
Adds a file name extension to a supplied name.
SYNTAX
Add-Extension [[-Name] <String>] [[-Extension] <String>] [<CommonParameters>]
DESCRIPTION
Adds a file name extension to a supplied name. Takes any strings for the file name or extension.
PARAMETERS
-Name
Specifies the file name.
Required? false
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters?
-Extension
Specifies the extension. "Txt" is the default.
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters?
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug,
-ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable,
-OutBuffer and -OutVariable. For more information, type
"get-help about_commonparameters".
INPUTs
None. You cannot pipe objects to Add-Extension.
OUTPUTS
System.String. Add-Extension returns a string with the extension or file name.
-------------------------- EXAMPLE 1 --------------------------
C:\PS> extension -name "File"
File.txt
-------------------------- EXAMPLE 2 --------------------------
C:\PS> extension -name "File" -extension "doc"
File.doc
-------------------------- EXAMPLE 3 --------------------------
C:\PS> extension "File" "doc"
File.doc
RELATED LINKS
http://www.fabrikam.com/extension.html
Set-Item
Exemple 2 : Descriptions des paramètres dans la syntaxe de la fonction
Cet exemple est le même que le précédent, sauf que les descriptions des paramètres sont insérées dans la syntaxe de la fonction. Ce format est particulièrement utile quand les descriptions sont courtes.
function Add-Extension
{
param
(
[string]
# Specifies the file name.
$name,
[string]
# Specifies the file name extension. \"Txt\" is the default.
$extension = "txt"
)
$name = $name + "." + $extension
$name
<#
.SYNOPSIS
Adds a file name extension to a supplied name.
.DESCRIPTION
Adds a file name extension to a supplied name. Takes any strings for the file name or extension.
.INPUTS
None. You cannot pipe objects to Add-Extension.
.OUTPUTS
System.String. Add-Extension returns a string with the extension or file name.
.EXAMPLE
C:\PS> extension -name "File"
File.txt
.EXAMPLE
C:\PS> extension -name "File" -extension "doc"
File.doc
.EXAMPLE
C:\PS> extension "File" "doc"
File.doc
.LINK
http://www.fabrikam.com/extension.html
.LINK
Set-Item
#>
}
Exemple 3 : Aide basée sur les commentaires pour un script
L’exemple de script suivant inclut une aide basée sur les commentaires.
Notez les lignes vides entre le « #> » fermant et l’instruction Param. Dans un script qui n’a pas d’instruction Param, il doit y avoir au moins deux lignes vides entre le commentaire final de la rubrique d’aide et la première déclaration de fonction. Sans ces lignes vides, Get-Help associe la rubrique d’aide à la fonction, et non pas au script.
<#
.SYNOPSIS
Performs monthly data updates.
.DESCRIPTION
The Update-Month.ps1 script updates the registry with new data generated
during the past month and generates a report.
.PARAMETER InputPath
Specifies the path to the CSV-based input file.
.PARAMETER OutputPath
Specifies the name and path for the CSV-based output file. By default,
MonthlyUpdates.ps1 generates a name from the date and time it runs, and
saves the output in the local directory.
.INPUTS
None. You cannot pipe objects to Update-Month.ps1.
.OUTPUTS
None. Update-Month.ps1 does not generate any output.
.EXAMPLE
C:\PS> .\Update-Month.ps1
.EXAMPLE
C:\PS> .\Update-Month.ps1 -inputpath C:\Data\January.csv
.EXAMPLE
C:\PS> .\Update-Month.ps1 -inputpath C:\Data\January.csv -outputPath C:\Reports\2009\January.csv
#>
param ([string]$InputPath, [string]$OutPutPath)
function Get-Data { }
...
La commande suivante obtient l’aide du script. Comme le script n’est pas dans un répertoire qui est répertorié dans la variable d’environnement Path, la commande Get-Help qui obtient l’aide du script doit spécifier le chemin d’accès du script.
PS C:\ps-test> get-help .\update-month.ps1 -full
NAME
C:\ps-test\Update-Month.ps1
SYNOPSIS
Performs monthly data updates.
SYNTAX
C:\ps-test\Update-Month.ps1 [-InputPath] <String> [[-OutputPath]
<String>] [<CommonParameters>]
DESCRIPTION
The Update-Month.ps1 script updates the registry with new data
generated during the past month and generates a report.
PARAMETERS
-InputPath
Specifies the path to the CSV-based input file.
Required? true
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters?
-OutputPath
Specifies the name and path for the CSV-based output file. By
default, MonthlyUpdates.ps1 generates a name from the date
and time it runs, and saves the output in the local directory.
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters?
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug,
-ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable,
-OutBuffer and -OutVariable. For more information, type,
"get-help about_commonparameters".
INPUTS
None. You cannot pipe objects to Update-Month.ps1.
OUTPUTS
None. Update-Month.ps1 does not generate any output.
-------------------------- EXAMPLE 1 --------------------------
C:\PS> .\Update-Month.ps1
-------------------------- EXAMPLE 2 --------------------------
C:\PS> .\Update-Month.ps1 -inputpath C:\Data\January.csv
-------------------------- EXAMPLE 3 --------------------------
C:\PS> .\Update-Month.ps1 -inputpath C:\Data\January.csv -outputPath
C:\Reports\2009\January.csv
RELATED LINKS
Exemple 4 : Redirection vers un fichier XML
Vous pouvez écrire des rubriques d’aide XML pour des fonctions et des scripts. Bien que l’aide basée sur les commentaires soit plus facile à implémenter, l’aide XML est nécessaire pour l’aide actualisable et pour fournir des rubriques d’aide dans plusieurs langues.
L’exemple suivant montre les premières lignes du script Update-Month.ps1. Le script utilise le mot clé ExternalHelp pour spécifier le chemin d’accès d’une rubrique d’aide XML pour le script.
Notez que la valeur du mot clé ExternalHelp apparaît sur la même ligne que le mot clé. Tout autre emplacement est sans effet.
# .ExternalHelp C:\MyScripts\Update-Month-Help.xml
param ([string]$InputPath, [string]$OutPutPath)
function Get-Data { }
...
L’exemple suivant montre trois emplacements valides du mot clé ExternalHelp dans une fonction.
function Add-Extension
{
# .ExternalHelp C:\ps-test\Add-Extension.xml
param ([string] $name, [string]$extension = "txt")
$name = $name + "." + $extension
$name
}
function Add-Extension
{
param ([string] $name, [string]$extension = "txt")
$name = $name + "." + $extension
$name
# .ExternalHelp C:\ps-test\Add-Extension.xml
}
# .ExternalHelp C:\ps-test\Add-Extension.xml
function Add-Extension
{
param ([string] $name, [string]$extension = "txt")
$name = $name + "." + $extension
$name
}
Exemple 5 : Redirection vers une autre rubrique d’aide
Le code suivant est un extrait du début de la fonction d’aide intégrée dans Windows PowerShell, qui affiche un écran d’aide à la fois. Comme la rubrique d’aide pour l’applet de commande Get-Help décrit la fonction d’aide, la fonction d’aide utilise les mots clés ForwardHelpTargetName et ForwardHelpCategory pour rediriger l’utilisateur vers la rubrique d’aide de l’applet de commande Get-Help.
function help
{
<#
.FORWARDHELPTARGETNAME Get-Help
.FORWARDHELPCATEGORY Cmdlet
#>
[CmdletBinding(DefaultParameterSetName='AllUsersView')]
param(
[Parameter(Position=0, ValueFromPipelineByPropertyName=$true)]
[System.String]
${Name},
...
La commande suivante utilise cette fonctionnalité :
C:\PS> get-help help
NAME
Get-Help
SYNOPSIS
Displays information about Windows PowerShell cmdlets and concepts.
...
MOTS CLÉS
about_Comment-Based_Help
VOIR AUSSI
about_Functions
about_Functions_Advanced_Parameters
about_Scripts
« Comment écrire l’aide des applets de commande » (https://go.microsoft.com/fwlink/?LinkID=123415)