Add-Dokumentation zu benutzerdefinierten Methoden (Script)

Question

Ein benutzerdefinierter Powershell-Skript oder Funktion kann zu Beginn seines Körpers mit einem Standardkommentar zu dokumentieren:

function wellDocumented { 
    <# 
     .SYNOPSIS 
     A well documented function 
     .DESCRIPTION 
     "Be verbose in documentation" - someone 
     .PARAMETER foo 
     should be 42 or 15, but not more 
    #> 
    param([int]$foo) 
    <# ... #> 
} 

Get-Help wellDocumented kehren einige netten Informationen dann. Aber wie kann ich benutzerdefinierte ScriptMethod s in benutzerdefinierten Objekten dokumentieren? Folgendes funktioniert nicht:

$myClass | add-member -memType ScriptMethod -Name "Foo" -Value { 
    <# 
     .SYNOPSIS 
     Something - but brief 
     .DESCRIPTION 
     Something 
    #> 
    <# ... #> 
} 

Gibt es eine Standardmethode, um Ihre ScriptMethods zu dokumentieren?

Answer 1

Sie können Ihr Skript Methode als separate Funktion schreiben ersten (wie Sie mit wellDocumented tat), dann die Funktion als Skript passieren:

$myClass | add-member -memType ScriptMethod -Name "Foo" -Value ${function:wellDocumented} 

Sie noch nicht Get-Help $myClass.Foo nennen kann, aber man kann Anruf Get-Help wellDocumented.

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