Escrevendo comentários em scripts bash

Ao escrever scripts Bash, é sempre uma boa prática tornar seu código limpo e facilmente compreensível. Organizar seu código em blocos, recuar, fornecer nomes descritivos para variáveis ​​e funções são várias maneiras de fazer isso.

Outra maneira de melhorar a legibilidade do seu código é usando comentários. Um comentário é uma explicação ou anotação legível por humanos, escrita no script de shell.

Adicionar comentários aos seus scripts do Bash economizará muito tempo e esforço quando você analisar seu código no futuro. Digamos que você queira alterar um script que você escreveu há alguns meses ou anos atrás. As chances são de que você não se lembrará por que escreveu um pedaço complicado de código, a menos que tenha adicionado um comentário.

Os comentários também ajudam outros desenvolvedores e administradores de sistema que talvez precisem manter o script para entender seu código e sua finalidade.

Os comentários geralmente são usados ​​para explicar o que o código não pode. Por exemplo, se você tiver uma regex complexa ou substituição de parâmetro no script Bash, escreva um comentário sobre o que o código faz. Os comentários devem ser breves e diretos. Não explique algo simples e óbvio para o leitor.

, abordaremos o básico sobre como escrever comentários no Bash.

Escrevendo comentários no Bash

O Bash ignora tudo o que está escrito após a marca de hash ( # ) na linha. A única exceção a essa regra é quando a primeira linha do script começa com o #! personagens. Essa sequência de caracteres é chamada Shebang e é usada para informar ao sistema operacional qual interpretador usar para analisar o restante do arquivo.

Os comentários podem ser adicionados no início da linha ou alinhados com outro código:

# This is a Bash comment. echo "This is Code" # This is an inline Bash comment.

O espaço em branco após a marca de hash não é obrigatório, mas melhorará a legibilidade do comentário.

Geralmente, quando o script é aberto em um editor de texto, os comentários são representados em verde.

Comentários também são úteis ao testar um script. Em vez de excluir algumas linhas ou blocos, você pode comentá-los:

# if]; then # echo "Variable is greater than 10." # fi

Comentários multilinhas no Bash

Diferentemente da maioria das linguagens de programação, o Bash não suporta comentários de várias linhas.

A maneira mais simples de escrever comentários com várias linhas no Bash é adicionar comentários únicos, um após o outro:

# This is the first line. # This is the second line.

Outra opção é usar o HereDoc. É um tipo de redirecionamento que permite passar várias linhas de entrada para um comando. Se o bloco HereDoc não for redirecionado para um comando, ele poderá servir como um espaço reservado para comentários de várias linhas:

<< 'MULTILINE-COMMENT' Everything inside the HereDoc body is a multiline comment MULTILINE-COMMENT

Usar o HereDoc é um hack, não uma maneira real de escrever comentários multilíngues do Bash. Para evitar problemas, você deve preferir usar comentários de linha única.

Conclusão

Escrever comentários é uma boa prática e ajuda outros desenvolvedores, inclusive o futuro, a entender o shell script. No Bash, tudo depois da marca de hash ( # ) e até o final da linha é considerado um comentário.

Se você tiver alguma dúvida ou comentário, fique à vontade para deixar um comentário.

terminal bash