Como adicionar comentários em Bash Scripts

1. Comentários de uma linha em Bash
2. Comentários Multi-Linha em Bash

Comentários são as linhas que o intérprete ignora e são usados apenas para descrever o que está acontecendo no código ou para dar uma idéia sobre o que um bloco ou linha de código em particular está fazendo. Os comentários tornam o código mais fácil de entender para quem lê o código. Podemos descrever o que está acontecendo no código em linguagem humana usando comentários. Também pode ser útil quando revisamos nosso código após algum tempo de escrita do código. Os comentários também são úteis durante a depuração do código. Em vez de remover a parte suspeita de ter um bug, podemos comentar a parte específica e depurar o código.

Podemos escrever comentários em Bash utilizando # e heredoc. Geralmente, # é utilizado para escrever comentários de uma linha, e heredoc é utilizado para escrever comentários de várias linhas.

Comentários de uma linha em Bash

Utilizamos símbolos # para escrever comandos de uma linha em Bash. Depois de #, tudo é ignorado ao interpretar o script, exceto a primeira linha que contém #!. Esta seqüência específica #! que aparece na primeira linha é chamada Shebang, e é utilizada para decidir qual intérprete utilizar.

Os comentários podem começar desde o início da linha, ou podem até estar em linha com o código.

#!/bin/bash
echo "Hello World!" # echo is similar to print statement.
# end of the code

Resultado:

Hello World!

Aqui, a primeira linha sugere que o compilador a ser utilizado é /bin/bash.

Na segunda linha, temos o comentário na linha e, na terceira linha, temos um comentário que começa do início da linha.

Comentários Multi-Linha em Bash

Bash não tem suporte para comentários de várias linhas. Uma maneira de escrever comentários de várias linhas em Bash é utilizando um único comentário de linha para cada linha.

# This is a
# multiline comment in Bash
echo "Hello World!"

Resultado:

Hello World!

Aqui, as linhas 1 e 2 podem ser consideradas como comentários de várias linhas onde cada linha é interpretada como um comentário separado pelo intérprete.

Também podemos tirar vantagem do Heredoc para escrever comandos de várias linhas. O Heredoc é um método para passar entradas de múltiplas linhas para um comando. Podemos utilizar Heredoc como um comentário de múltiplas linhas se o Heredoc não for redirecionado para qualquer comando.

#!/bin/bash

<< 'Comment'
    Everything inside the
    HereDoc body is
    a multiline comment
Comment
echo "Hello World!" 

Resultado:

Hello World!

Aqui, as linhas 3-7 são consideradas como um comentário multi-linhas pelo intérprete.