Como criar comentários descritivos de PowerShell

PowerShell Script suporta comentários para adicionar instruções legíveis por humanos. Mais especificamente, os comentários são adicionados ao script para fins de depuração e documentação. Esses comentários descritivos ajudam outros programadores a entender o código mais claramente. Comentários descritivos podem ser comentários de linha única ou de múltiplas linhas.

Este artigo discutirá vários métodos para criar comentários descritivos.

Como criar comentários descritivos de PowerShell?

No PowerShell, os comentários descritivos podem ser criados usando os métodos abaixo mencionados:

• Comentários descritivos de linha única.
• Comentários descritivos multilinas.

Método 1: Comentários descritivos de linha única

Comentários de linha única podem ser criados para adicionar descrições de código usando o “#" hashtag. O texto escrito ao lado da hashtag será considerado o comentário. Esses comentários são usados ​​para adicionar pequenas descrições de código.

Exemplo
Este exemplo demonstrará adicionar um comentário de linha única no script PowerShell:

# Este é um comentário de linha única.
Escreva-host "Comentário descritivo não exibirá."
# Comentário descritivo de linha única

De acordo com o código acima:

• Primeiro, crie um comentário de linha única usando o “#" hashtag.
• Depois disso, especifique o “Gravação-host”Cmdlet para adicionar uma linha de string.
• Finalmente, adicione o comentário de linha única:

Pode-se observar que o comentário descritivo de linha única foi adicionada com sucesso e não foi exibida no console do PowerShell.

Método 2: Comentários descritivos multilinas

Os comentários parecem bons quando são curtos e concisos, mas é a necessidade de escrever comentários descritivos detalhados. Esses comentários são chamados de blocos de multilina ou comentários. Mais especificamente, comentários multilinas ou blocos de comentários começam com este símbolo “<#”E termine com este“#>”Símbolo. Tudo escrito dentro desses símbolos será considerado como comentários descritivos de várias linhas.

Exemplo
Este exemplo ilustrará a criação dos comentários multilinas em PowerShell:

<# Description
do código
pode ser adicionado aqui
#>
Escreva-host "Este é um exemplo de comentário de várias linhas."

De acordo com o código acima:

• Primeiro, adicione o comentário multilina no início “<#"E terminando"#>”Símbolos.
• Depois disso, adicionamos o “Gravação-host”Cmdlet para adicionar uma linha de string:

O comentário descritivo de várias linhas foi adicionado com sucesso e não foi exibido no console do PowerShell.

Conclusão

O comentário descritivo em PowerShell pode ser criado usando comentários de linha única e múltipla. Comentários únicos podem ser criados adicionando a hashtag “#”Hashtag no início da linha. Enquanto os comentários de múltiplas linhas são criados dentro do “<#”Iniciando e o“#>Símbolos finais. Este blog elaborou um guia detalhado para criar comentários descritivos de PowerShell.