PowerShell HelpWriter

PowerShell HelpWriter est l’éditeur principal pour les fichiers d’aide XML de Windows PowerShell. Créez et modifiez des fichiers d’aide pour tous les types de commandes, y compris les cmdlets, les fonctions, les workflows et les commandes CIM. Concentrez-vous sur votre contenu et laissez PowerShell HelpWriter se préoccuper de l’XML.

PowerShell HelpWriter analyse votre module et génère des fichiers d’aide de démarrage qui correspondent au code du cmdlet et convertit les aides basées sur des commentaires existants.

Exportez votre aide PowerShell vers HTML ou markdown en appuyant sur un bouton.

Rédigez l’aide pour un module avant que le code ne soit écrit en tant que spécification de code. Une fois l’aide rédigée, utilisez la fonction Nouveau module de PowerShell Studios à partir du fichier d’aide pour générer automatiquement le code des modules.

Principales fonctionnalités:

• Interface utilisateur de l’éditeur d’aide complet: Offre un éditeur dynamique qui vous guide dans le processus d’écriture de sujets d’aide complets et précis pour toutes vos commandes.
• Générer des fichiers d’aide à partir des modules: Pas besoin de partir de zéro. PowerShell HelpWriter analyse votre module et génère des fichiers d’aide de démarrage qui correspondent au code du cmdlet.
• Gérer les fichiers d’aide du module: Utilisez un projet de module pour gérer et modifier plusieurs fichiers d’aide XML et d’aide. Rafraîchissez le contenu d’aide des modules en appuyant sur un bouton.
• Vérification orthographique en temps réel: PowerShell HelpWriter propose une vérification orthographique en temps réel pendant que vous écrivez.
• L’aide correspond au code: PowerShell HelpWriter génère des sujets d’aide de démarrage à partir du code de n’importe quelle commande de n’importe quel type, y compris les commandes individuelles et les commandes dans un module. Pas besoin de comprendre les valeurs des attributs cmdlet ou des attributs de paramètre, les entrées ou les sorties. Et l’aide correspond toujours au code.
• Modifier en XML: Chaque fois que vous en avez besoin, vous pouvez afficher ou modifier le fichier d’aide dans l’éditeur XML intégré. L’éditeur XML de PowerShell HelpWriter est un éditeur XML complet, pas seulement une lecture.
  • Seul visionneur.
  •  Modifier les fichiers d’aide existants: Modifier les fichiers d’aide existants dans l’interface utilisateur de l’éditeur PowerShell Help Writer ou en tant que XML. Ajouter ou supprimer des paramètres, y compris des paramètres dynamiques.
  • Créer des fichiers d’aide à partir de zéro: Utilisez l’éditeur PowerShell HelpWriter pour créer de l’aide à partir de zéro pour des modules nouveaux ou existants.
  • Convertir l’aide basée sur les commentaires en PSMAML: Génère une aide de démarrage à partir de l’aide existante dans vos nouveaux fichiers PSMAML, y compris l’aide basée sur les commentaires pour les fonctions.
  • Exportation en Markdown et HTML: Exporter l’aide des cmdlets et des sujets à propos en markdown ou HTML.
  • Conception avant codage: Rédiger de l’aide pour un module avant que le code ne soit écrit en tant que spécification de code. Une fois l’aide rédigée, utilisez la fonctionnalité Nouveau module à partir du fichier d’aide de PowerShell Studios pour générer automatiquement le code des modules.
  • Valider les fichiers PSMAML: Tous les fichiers d’aide sont conformes au schéma PSMAML pour les fichiers d’aide Windows PowerShell. Utilisez la fonctionnalité de validation du schéma d’aide pour valider n’importe quel fichier. PowerShell HelpWriter corrigera automatiquement les problèmes structurels courants afin de se conformer au schéma d’aide MAML.