PowerShell MAML Helfen Generator

Question

Kennt jemand ein utility zur Erzeugung von PowerShell-cmdlet-Hilfedateien?Tun Sie es von hand, es scheint ein bisschen langweilig...

Ich Sitz: http://blogs.msdn.com/powershell/archive/2007/09/01/new-and-improved-cmdlet-help-editor-tool.aspx

Eventuell aktualisierte Versionen?Ich kann nicht wählen Sie ein Modul aus.Ich habe ein binäres Modul.

Answer 1

Ich habe ein Powershell-Skript erstellt, das MAML für Cmdlets und Funktionen unabhängig davon, ob sie einen Teil der Module generieren. Es ist nicht perfekt, wie die erzeugte MAML wird einige manuelle Bearbeitung erfordern, aber so funktioniert das Cmdlet Hilfe-Editor Sie verwiesen. Ich habe eine Blog-Post über das hier

Wenn Sie es verwenden und finden Korrekturen aktualisieren sich bitte an dem Skript auf PoshCode .

Answer 2

Ich hatte meine Modul zu dokumentieren und fanden keine bessere Lösung als meine eigene MAML Hilfe Builder zu erstellen. Hier ist es: https://github.com/nightroman/Helps

Das Modul baut Powershell MAML Hilfedateien von Powershell-Hilfe-Skripten. Hilfe Skripte sind fast WYSIWYG, sie sehen sehr ähnlich dem Ergebnis Hilfe. Dennoch sind sie nur Skripte und dies einfach eine Menge nützlicher Funktionen macht. Einer von ihnen ist für verschiedene Kulturen Hilfedateien zu bauen.

Hier ist die Vorlage von Hilfedaten für Befehle (Cmdlets, Funktionen, Skripte) und Anbieter:

### Command help data

@{
    command = 'Name'
    synopsis = '...'
    description = '...'
    sets = @{
        Set1 = '...'
        #...
    }
    parameters = @{
        Param1 = '...'
        #...
    }
    inputs = @(
        @{
            type = '...'
            description = '...'
        }
        #...
    )
    outputs = @(
        @{
            type = '...'
            description = '...'
        }
        #...
    )
    notes = '...'
    examples = @(
        @{
            title = '...'
            introduction = '...'
            code = {
            }
            remarks = '...'
            test = {
                . $args[0]
            }
        }
        #...
    )
    links = @(
        @{
            text = '...'
            URI = '...'
        }
        #...
    )
}

### Provider help data

@{
    provider = 'Name'
    drives = '...'
    synopsis = '...'
    description = '...'
    capabilities = '...'
    tasks = @(
        @{
            title = '...'
            description = '...'
            examples = @(
                @{
                    title = '...'
                    introduction = '...'
                    code = {
                    }
                    remarks = '...'
                    test = {
                        . $args[0]
                    }
                }
            )
        }
        #...
    )
    parameters = @(
        @{
            name = '...'
            type = '...'
            description = '...'
            cmdlets = '...'
            values = @(
                @{
                    value = '...'
                    description = '...'
                }
                #...
            )
        }
        #...
    )
    notes = '...'
    links = @(
        @{
            text = '...'
            URI = '...'
        }
        #...
    )
}

Answer 3

Ich habe auf einem Weg, um die Dokumentation im snapin / Modul C # -Code und einzubetten PoshBuild beginnt wie meine beste Option zu suchen. Es ist nicht bieten eine Möglichkeit, einige der Dokumentationselemente (zum Beispiel Synopse und Beispiele) enthalten, aber es ist immer noch eine gute Option.

Answer 4

In Bezug auf die grafische Werkzeuge für die Bearbeitung von XML-Powershell-Hilfe (PSMAML) können Sie:

• Powershell-Cmdlets Hilfe Editor (Open Source, so etwas wie ein geistigen Nachfolger Cmdlets Hilfe Editor).
• Powershell HelpWriter (Commercial).

Answer 5

Mit dem Aufkommen der open-source - XmlDoc2CmdletDoc, können Sie nun ein Dokument in Ihrem Binär PowerShell-cmdlets (d.h.diejenigen, die in C# geschrieben), wie jede andere C# - Bibliotheken, und wie scripted cmdlets (geschrieben in PowerShell):verwenden Sie inline-Dokumentation kommentiert.

Sie müssen nicht mehr zu halten parallel MAML - Datei durch hand!Nur Ihr instrument zu bauen, so dass, wenn Sie kompilieren Sie Ihr C# - Projekt führt die Dokumentation generator und Sie erhalten beide eine Modul.dll und eine Modul.dll-Help.xml.Letztere werden direkt von PowerShell zu helfen, auf Ihre cmdlets, wenn Sie rufen Get-Help.

Und XmlDoc2CmdletDoc bietet sogar eine -strict - Schalter, um sicherzustellen, dass Sie umfassend dokumentiert Ihre cmdlets;wenn Sie verwenden Sie den Schalter und Sie etwas verpasst, Ihr build fehlschlägt, wie es sollte.

Andere Vorteile, die automatisch zur Verfügung gestellt von XmlDoc2CmdletDoc ("Abschnitte" in diese Liste bezieht sich auf die Abschnitte der Hilfe präsentiert von Get-Help):

• Jeder benutzerdefinierte Typ in der Ausgänge Abschnitt enthält eine Beschreibung.
• Die Syntax Abschnitt enthält mögliche Werte für Aufzählungstypen.
• Die Parameter Abschnitt enthält mögliche Werte für Aufzählungstypen.
• Aliase werden automatisch dokumentiert in der Parameter Abschnitt.
• Aliase behandelt werden als first-class-Parameter, so können Sie um Hilfe bitten auf eines Pseudonyms gestattet.
• Optional können Sie eine andere Bezeichnung für einen parameter in der Eingänge Abschnitt, wie Sie für die Parameter Abschnitt.
• Web-links automatisch gerendert in markdown format, um die post-Verarbeitung, um live-links.(Diese Verbesserung ist angemeldet.)

Ich mochte dieses open-source-Dienstprogramm, so viel ich begann, die dazu beitragen, die Bereitstellung mehrerer der oben genannten Vorteile.Und ich schrieb eine umfassende Anleitung zur Verwendung berechtigt Mit Der Dokumentation Der PowerShell Binären Cmdlets, nur veröffentlicht auf Simple-Talk.com.