Colocar a ajuda baseada em comentários em scripts

Este tópico explica onde colocar ajuda baseada em comentários para um script para que o cmdlet Get-Help associe o tópico de ajuda baseado em comentários a scripts e não a funções que possam estar no script.

Onde colocar Comment-Based ajuda para um script

• No início do arquivo de script.

  A Ajuda de Script pode ser precedida no script somente por comentários e linhas em branco.

• No final do arquivo de script.

  Se o primeiro item no corpo do script (após a Ajuda) for uma declaração de função, deverá haver pelo menos duas linhas em branco entre o final da Ajuda de script e a declaração de função. Caso contrário, a Ajuda será interpretada como sendo a Ajuda para a função, não a Ajuda para o script.

Exemplos de posicionamento de ajuda em um script

Os exemplos a seguir mostram cada uma das opções de posicionamento para ajuda baseada em comentários para um script.

Ajuda no início de um script

O exemplo a seguir mostra o comentário baseado no início de um script.

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

param [string]$ComputerName
...

Ajuda no final de um script

O exemplo a seguir mostra comentários baseados no final de um script.

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

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