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:
Gibt es eine Standardmethode, um Ihre ScriptMethods zu dokumentieren?
Sie können Ihre Skriptmethode zuerst als separate Funktion schreiben (wie bei wellDocumented
) und dann die Funktion als Skriptblock übergeben:
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.
Tags und Links powershell powershell-v2.0 powershell-v3.0