向自定义方法添加文档(ScriptMethod)

时间:2014-10-29 11:48:40

标签: powershell powershell-v2.0 powershell-v3.0

可以使用标准注释在其正文开头记录自定义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?

1 个答案:

答案 0 :(得分:1)

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

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

您仍然无法致电Get-Help $myClass.Foo,但可以致电Get-Help wellDocumented

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