通过

在函数中放置基于注释的帮助

本主题说明在何处放置函数的基于注释的帮助，以便 Get-Help cmdlet 将基于注释的帮助主题与正确的函数相关联。

在何处放置函数 Comment-Based 帮助

  • 函数正文的开头。

  • 函数正文的结尾。

  • Function 关键字之前。 当函数位于脚本或脚本模块中时，基于注释的帮助的最后一行和 Function 关键字之间不能有多个空白行。 否则，Get-Help 将帮助与脚本相关联，而不是与函数相关联。

函数中的帮助放置示例

以下示例显示了函数基于注释的帮助的三个放置选项中的每一个。

函数主体开头的帮助

以下示例显示基于注释的函数正文开头。

function MyProcess
{
    <#
       .DESCRIPTION
       The MyProcess function gets the Windows PowerShell process.
    #>

    Get-Process powershell
}

函数体末尾的帮助

以下示例演示函数正文末尾基于注释。

function MyFunction
{
    Get-Process powershell

    <#
       .DESCRIPTION
       The MyProcess function gets the Windows PowerShell process.
    #>
}

函数关键字之前的帮助

以下示例演示基于函数关键字之前的行的注释。

<#
    .DESCRIPTION
    The MyProcess function gets the Windows PowerShell process.
#>
function MyFunction { Get-Process powershell}