PowerShell HelpWriter

PowerShell HelpWriter ist der führende Editor für Windows PowerShell XML-Hilfedateien. Erstellen und bearbeiten Sie Hilfedateien für alle Befehlstypen, einschließlich Cmdlets, Funktionen, Workflows und CIM-Befehle. Konzentrieren Sie sich auf Ihren Inhalt und lassen Sie PowerShell HelpWriter sich um das XML kümmern.

PowerShell HelpWriter analysiert Ihr Modul und generiert Starterhilfedateien, die dem Cmdlet-Code entsprechen, und konvertiert vorhandene kommentarbasierte Hilfe.

Exportieren Sie Ihre PowerShell-Hilfe auf Knopfdruck in HTML oder Markdown.

Schreiben Sie Hilfe für ein Modul, bevor der Code geschrieben wird, als Codespezifikation. Sobald die Hilfe geschrieben ist, verwenden Sie das Feature Neues Modul aus Hilfedatei von PowerShell Studios, um automatisch den Modulcode zu generieren.

Wichtige Funktionen:

• Vollständiger Hilfe-Editor-Benutzeroberfläche: Bietet einen dynamischen Editor, der Sie durch den Prozess des Schreibens vollständiger und genauer Hilfethemen für alle Ihre Befehle führt.
• Generieren von Hilfedateien aus Modulen: Kein Neuanfang erforderlich. PowerShell HelpWriter analysiert Ihr Modul und generiert Starterhilfedateien, die dem Cmdlet-Code entsprechen.
• Verwalten von Modulhilfedateien: Verwenden Sie ein Modulprojekt, um mehrere Hilfe-XML- und About-Hilfedateien zu verwalten und zu bearbeiten. Aktualisieren Sie den Hilfeinhalt der Module auf Knopfdruck.
• Echtzeit-Rechtschreibprüfung: PowerShell HelpWriter bietet Echtzeit-Rechtschreibprüfung beim Schreiben.
• Hilfe entspricht dem Code: PowerShell HelpWriter generiert Starterhilfethemen aus dem Code in jedem Befehl jedes Typs, einschließlich einzelner Befehle und Befehle in einem Modul. Es ist nicht erforderlich, die Cmdlet- oder Parameterattributwerte, Eingaben oder Ausgaben herauszufinden. Und die Hilfe entspricht immer dem Code.
• In XML bearbeiten: Wenn Sie es benötigen, können Sie die Hilfedatei im integrierten XML-Editor anzeigen oder bearbeiten. Der PowerShell HelpWriter XML-Editor ist ein vollständiger XML-Editor, kein reiner Lese- und Schreibeditor.

• Nur für Betrachter:
•  Bestehende Hilfedateien bearbeiten: Bearbeiten Sie bestehende Hilfedateien im PowerShell Help Writer-Editor UI oder als XML. Fügen Sie Parameter hinzu oder löschen Sie diese, einschließlich dynamischer Parameter.
• Hilfedateien von Grund auf erstellen: Verwenden Sie den PowerShell HelpWriter-Editor, um Hilfe von Grund auf für neue oder bestehende Module zu erstellen.
• Konvertieren von Kommentar-basierter Hilfe in PSMAML: Generiert Starterhilfe aus vorhandener Hilfe in Ihren neuen PSMAML-Dateien, einschließlich kommentarbasierter Hilfe für Funktionen.
• Markdown und HTML-Export: Exportieren Sie Cmdlet-Hilfe und Themen zu Markdown oder HTML.
• Design vor dem Codieren: Schreiben Sie Hilfe für ein Modul, bevor der Code als Codespezifikation geschrieben wird. Sobald die Hilfe verfasst ist, verwenden Sie die Funktion ‚Neues Modul aus Hilfedatei generieren‘ von PowerShell Studios, um automatisch den Code des Moduls zu generieren.
• PSMAML-Dateien validieren: Alle Hilfedateien entsprechen dem PSMAML-Schema für Windows PowerShell-Hilfedateien. Verwenden Sie die Funktion ‚Hilfeschema validieren‘, um eine beliebige Datei zu validieren. PowerShell HelpWriter korrigiert automatisch häufige strukturelle Probleme, um dem MAML-Hilfeschema zu entsprechen.