Размещение справки на основе комментариев в сценариях

В этом разделе объясняется, где разместить справку на основе комментариев для скрипта, чтобы командлет Get-Help связывает раздел справки на основе комментариев с скриптами, а не с функциями, которые могут находиться в скрипте.

Место 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.
#>