Partager via

Guide pratique pour créer le fichier d’aide d’une applet de commande

Cette section explique comment créer un fichier XML valide qui contient du contenu pour Windows PowerShell rubriques d’aide sur les applets de commande. Cette section explique comment nommer le fichier d’aide, comment ajouter les en-têtes XML appropriés et comment ajouter des nœuds contenant les différentes sections du contenu d’aide de l’applet de commande.

Notes

Pour obtenir une vue complète d’un fichier d’aide, ouvrez l’un dll-Help.xml des fichiers situés dans le répertoire d’installation Windows PowerShell. Par exemple, le fichier contient du Microsoft.PowerShell.Commands.Management.dll-Help.xml contenu pour plusieurs applets de commande PowerShell.

Guide pratique pour créer un fichier d’aide d’applet de commande

  1. Créez un fichier texte et enregistrez-le à l’aide de l’encodage UTF8. Le nom de fichier doit avoir le format suivant afin que Windows PowerShell puisse le détecter en tant que fichier d’aide de l’applet de commande.

    <PSSnapInAssemblyName>.dll-Help.xml

  2. Ajoutez les en-têtes XML suivants au fichier texte. N’oubliez pas que le fichier sera validé par rapport au schéma MAML (Microsoft Assistance Markup Language). Actuellement, PowerShell ne fournit aucun outil pour valider le fichier.

    <?xml version="1.0" encoding="utf-8" ?> <helpItems xmlns="http://msh" schema="maml">

  3. Ajoutez un nœud De commande au fichier d’aide de l’applet de commande pour chaque applet de commande de l’assembly. Chaque nœud du nœud Commande est lié aux différentes sections de la rubrique d’aide de l’applet de commande.

    Le tableau suivant répertorie l’élément XML pour chaque nœud, suivi d’une description de chaque nœud.

    Nœud Description
    <details> Ajoute du contenu pour les sections NAME et SYNOPSIS de la rubrique d’aide de l’applet de commande. Pour plus d’informations, consultez Comment ajouter le nom de l’applet de commande et le synopsis.
    <maml:description> Ajoute du contenu pour la section DESCRIPTION de la rubrique d’aide de l’applet de commande. Pour plus d’informations, consultez Comment ajouter la description détaillée à une rubrique d’aide sur les applets de commande.
    <command:syntax> Ajoute du contenu pour la section SYNTAXE de la rubrique d’aide de l’applet de commande. Pour plus d’informations, consultez Comment ajouter une syntaxe à une rubrique d’aide sur les applets de commande.
    <command:parameters> Ajoute du contenu pour la section PARAMETERS de la rubrique d’aide de l’applet de commande. Pour plus d’informations, consultez Comment ajouter des paramètres à une rubrique d’aide sur les applets de commande.
    <command:inputTypes> Ajoute du contenu pour la section ENTRÉES de la rubrique d’aide de l’applet de commande. Pour plus d’informations, consultez Comment ajouter des types d’entrée à une rubrique d’aide sur les applets de commande.
    <command:returnValues> Ajoute du contenu pour la section OUTPUTS de la rubrique d’aide de l’applet de commande. Pour plus d’informations, consultez Comment ajouter des valeurs de retour à une rubrique d’aide sur les applets de commande.
    <maml:alertset> Ajoute du contenu pour la section NOTES de la rubrique d’aide de l’applet de commande. Pour plus d’informations, consultez Comment ajouter des notes à une rubrique d’aide sur les applets de commande.
    <command:examples> Ajoute du contenu pour la section EXAMPLES de la rubrique d’aide de l’applet de commande. Pour plus d’informations, consultez Comment ajouter des exemples à une rubrique d’aide sur les applets de commande.
    <maml:relatedLinks> Ajoute du contenu pour la section RELATED LINKS de la rubrique d’aide de l’applet de commande. Pour plus d’informations, consultez Comment ajouter des liens connexes à une rubrique d’aide sur les applets de commande.

 Exemple

Voici un exemple de nœud De commande qui inclut les nœuds pour les différentes sections de la rubrique d’aide de l’applet de commande.

<command:command
  xmlns:maml="http://schemas.microsoft.com/maml/2004/10"
  xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"
  xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
  <command:details>
    <!--Add name and synopsis here-->
  </command:details>
  <maml:description>
    <!--Add detailed description here-->
  </maml:description>
  <command:syntax>
    <!--Add syntax information here-->
  </command:syntax>
  <command:parameters>
    <!--Add parameter information here-->
  </command:parameters>
  <command:inputTypes>
    <!--Add input type information here-->
  </command:inputTypes>
  <command:returnValues>
    <!--Add return value information here-->
  </command:returnValues>
  <maml:alertSet>
    <!--Add Note information here-->
  </maml:alertSet>
  <command:examples>
    <!--Add cmdlet examples here-->
  </command:examples>
  <maml:relatedLinks>
    <!--Add links to related content here-->
  </maml:relatedLinks>
</command:command>

Voir aussi

Comment ajouter le nom de l’applet de commande et le synopsis

Comment ajouter la description détaillée à une rubrique d’aide sur les applets de commande

Guide pratique pour ajouter la syntaxe à une rubrique d’aide d’applet de commande

Guide pratique pour ajouter des paramètres à une rubrique d’aide sur les applets de commande

Guide pratique pour ajouter des types d’entrée à une rubrique d’aide d’applet de commande

Guide pratique pour ajouter des valeurs de retour à une rubrique d’aide d’applet de commande

Guide pratique pour ajouter des notes à une rubrique d’aide sur les applets de commande

Guide pratique pour ajouter des exemples à une rubrique d’aide d’applet de commande

Guide pratique pour ajouter des liens connexes à une rubrique d’aide d’applet de commande

Windows PowerShell SDK

  • Last updated on