dodawania dokumentacja metod niestandardowych (ScriptMethod)

Question

Niestandardowy skrypt PowerShell lub funkcja może być udokumentowane za pomocą standardowego komentarza na początku swojego ciała:

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 powraca kilka ciekawych informacji wtedy. Ale jak mogę udokumentować niestandardowe obiekty w niestandardowych obiektach? Następujące funkcje nie działają:

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

Czy istnieje jakiś standardowy sposób dokumentowania skryptów ScriptMethod?

Answer 1

można napisać metodę skryptu jako pierwszy osobnej funkcji (jak to zrobiłeś z wellDocumented), a następnie przekazać funkcję jako scriptblock:

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

nadal nie można nazwać Get-Help $myClass.Foo, ale można zadzwoń pod numer Get-Help wellDocumented.

Podczas testów nie udało mi się uzyskać pomocy dotyczącej metody.