在脚本中放置基于注释的帮助

本主题说明在何处放置脚本的基于注释的帮助,以便 Get-Help cmdlet 将基于注释的帮助主题与脚本相关联,而不与脚本中的任何函数相关联。

在何处放置脚本 Comment-Based 帮助

  • 脚本文件的开头。

    脚本帮助的前面只能有注释和空白行。

  • 脚本文件的末尾。

    如果脚本正文(帮助后)的第一项是函数声明,则脚本帮助末尾和函数声明之间必须至少有两个空白行。 否则,帮助被解释为函数的帮助,而不是脚本的帮助。

脚本中的帮助放置示例

以下示例显示了脚本基于注释的帮助的每个放置选项。

脚本开头的帮助

以下示例演示脚本开头的基于注释。

<#
.DESCRIPTION
This script performs a series of network connection tests.
#>

param [string]$ComputerName
...

脚本末尾的帮助

以下示例演示脚本末尾基于注释。

...
function Ping { Test-Connection -ComputerName $ComputerName }

<#
.DESCRIPTION
This script performs a series of network connection tests.
#>