Articles

Sintaxe da Ajuda Baseada no Início – PowerShell | Microsoft Docs Sintaxe da Ajuda Baseada no InícioAjuda Baseada

Posted on
  • 09/12/2016
  • 2 minutos para ler
  • ul>
  • >j
  • s
  • n

/li>

Esta secção descreve a sintaxe de elogio…ajuda baseada.

Diagrama da sintaxe

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

# .< help keyword># <help content>-or -<#.< help keyword>< help content>#>

Descrição da sintaxe

Ajuda baseada em comentários é escrita como uma série de comentários. Pode digitar um símbolo de comentário (#) antes de cada linha de comentários, ou pode 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 secção da Ajuda baseada em comentários é definida por uma palavra-chave e cada palavra-chave é precedida por um ponto(.). As palavras-chave podem aparecer em qualquer ordem. Os nomes das palavras-chave não são sensíveis a maiúsculas/minúsculas.

Um bloco de comentários deve conter pelo menos uma palavra-chave de ajuda. Algumas das palavras-chave, como EXEMPLO, 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 de um tópico de Ajuda baseado em comentários devem ser contíguas. Se um tópico da Ajuda baseado em comentários segue 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 sem ajuda e o início da Ajuda baseada em comentários.

Deixe uma resposta

O seu endereço de email não será publicado. Campos obrigatórios marcados com *