Placing Comment-Based Help in Scripts (Colocar Ajuda Baseada em Comentários em Scripts)

Este tópico explica onde colocar a 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 quaisquer 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 apenas 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, deve haver pelo menos duas linhas em branco entre o final da Ajuda do script e a declaração da função. Caso contrário, a Ajuda é interpretada como sendo Ajuda para a função, não Ajuda para o script.

Exemplos de posicionamento da 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 comentários baseados 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.
#>