Sintaxe de ajuda baseada em comentários

Esta seção descreve a sintaxe da ajuda baseada em comentários.

Diagrama de sintaxe

A sintaxe da Ajuda baseada em comentários é a seguinte:

# .< help keyword>
# <help content>

- ou -

<#
.< help keyword>
< help content>
#>

Descrição da sintaxe

A Ajuda baseada em comentários é escrita como uma série de comentários. Você pode digitar um símbolo de comentário (#) antes de cada linha de comentários ou usar os símbolos <# e #> para criar um bloco de comentários. Todas as linhas dentro do bloco de comentários são interpretadas como comentários.

Cada seção da Ajuda baseada em comentário é definida por uma palavra-chave e cada palavra-chave é precedida por um ponto (.). As palavras-chave podem aparecer em qualquer ordem. Os nomes de palavra-chave não diferenciam maiúsculas e minúsculas.

Um bloco de comentários deve conter pelo menos uma palavra-chave de ajuda. Algumas das palavras-chave, como .EXAMPLE, podem aparecer muitas vezes no mesmo bloco de comentários. O conteúdo da Ajuda para cada palavra-chave começa na linha após a palavra-chave e pode abranger várias linhas.

Todas as linhas em um tópico da Ajuda baseada em comentários devem ser contíguas. Se um tópico de Ajuda baseado em comentários seguir um comentário que não faz parte do tópico da Ajuda, deve haver pelo menos uma linha em branco entre a última linha de comentário que não seja da Ajuda e o início da Ajuda baseada em comentários.

Por exemplo, o tópico de ajuda baseado em comentário a seguir contém a palavra-chave .DESCRIPTION e seu valor, que é uma descrição de uma função ou script.

<#
    .DESCRIPTION
    The Get-Function function displays the name and syntax of all functions in the session.
#>