Dokumentation zu benutzerdefinierten Methoden hinzufügen (ScriptMethod)

8

Ein benutzerdefiniertes PowerShell-Skript oder eine benutzerdefinierte PowerShell-Funktion kann mit einem Standardkommentar am Anfang des Rumpfes dokumentiert werden:

%Vor%

Get-Help wellDocumented gibt dann einige nette Informationen zurück. Aber wie kann ich benutzerdefinierte ScriptMethod s in benutzerdefinierten Objekten dokumentieren? Folgendes funktioniert nicht:

%Vor%

Gibt es eine Standardmethode, um Ihre ScriptMethods zu dokumentieren?

    
Sh4pe 29.10.2014, 11:48
quelle

1 Antwort

1

Sie können Ihre Skriptmethode zuerst als separate Funktion schreiben (wie bei wellDocumented ) und dann die Funktion als Skriptblock übergeben:

%Vor%

Sie können weiterhin Get-Help $myClass.Foo nicht aufrufen, aber Sie können Get-Help wellDocumented aufrufen.

Bei meinen Tests konnte ich keine Hilfe zu einer Methode bekommen.

    
briantist 29.10.2014 14:19
quelle