So fügen Sie Synopsis / Summary für ein Cmdlet in C # hinzu?

Question

Angenommen, Sie schreiben einige pscmdlet in c #:

generasacodicetagpre.

Wenn das oben definierende Modul in PowerShell geladen ist, gibt der Befehl generationstabedagcode das folgende zurück:

generasacodicetagpre.

Wie kann ich eine Zusammenfassung / Zusammenfassung für dieses Cmdlet hinzufügen, z.das gleiche wie bei help Join-StackOverflow:

generasacodicetagpre.

Answer 1

Cmdlet-Hilfe ist normalerweise in der Satelliten-XML-Datei.Angenommen, das Cmdlet befindet sich im Modul myModule.dll , die Hilfedatei ist normalerweise in myModule \ en-us \ myModule.dll-help.xml

help xml ist das sogenannte MAML-Format.Um es zu vermeiden, dass es jedes Mal manuell komponiert wurde, erstellte ich ein Werkzeug (Skriptbibliothek) .Es erzeugt ein Template-Help-Skript für ein Cmdlet, das der Hilfe etwas ähnlich aussieht.Hier ist ein Beispiel .Dann nach dem Füllen von Leerzeichen ( Beispiel ), ein weiterer Hilfsbefehl wird aufgerufen, dieses Skript in MAML XML zu konvertieren.

p.s.Es gibt andere Helfer-Tools im Web.Ich habe ein paar von ihnen ausprobiert und beschlossen, meine eigenen zu erstellen.

Answer 2

Hier ist die grundlegende Struktur der Datei myModule.dll-help.xml, die sich in demselben Verzeichnis wie das Modul-DLL selbst befinden oder in einem Kulturuntererzeichnis (z. B. EN-US):

generasacodicetagpre.