powershell - 将文档添加到自定义方法(ScriptMethod)

自定义PowerShell脚本或函数可以在其主体的开头带有标准注释的文档中进行记录:

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然后返回一些很好的信息。但是，如何在自定义对象中记录自定义ScriptMethod呢？以下内容不起作用:

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

有一些标准方法可以记录您的ScriptMethods吗？

最佳答案

您可以先将脚本方法编写为单独的函数(就像使用wellDocumented一样)，然后将该函数作为脚本块传递:

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

您仍然无法调用Get-Help $myClass.Foo，但是可以调用Get-Help wellDocumented。

在测试中，我无法获得方法方面的帮助。

关于powershell - 将文档添加到自定义方法(ScriptMethod)，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/26629558/