Maneira de criar comentários multilinhas no Bash?

Recentemente, comecei a estudar shell script e gostaria de poder comentar um conjunto de linhas em um shell script. Quero dizer, como é no caso de C / Java:

/* comment1
   comment2 
   comment3
*/`

Como eu pude fazer isso?

Use : 'para abrir e 'fechar.

Por exemplo:

: '
This is a
very neat comment
in bash
'

Comentário multilinha no bash

: <<'END_COMMENT'
This is a heredoc (<<) redirected to a NOP command (:).
The single quotes around END_COMMENT are important,
because it disables variable resolving and command resolving
within these lines.  Without the single-quotes around END_COMMENT,
the following two $() `` commands would get executed:
$(gibberish command)
`rm -fr mydir`
comment1
comment2 
comment3
END_COMMENT

Como estou atualizando esta postagem com base em comentários e outras respostas, os comentários anteriores a 22 de maio de 2020 podem não se aplicar mais.

O Bash não fornece uma sintaxe interna para comentários de várias linhas, mas há hacks usando a sintaxe do bash existente que "funcionam agora".

Pessoalmente, acho que o mais simples (ou seja, menos barulhento, menos estranho, mais fácil de digitar, mais explícito) é usar um HEREDOC citado, mas torne óbvio o que você está fazendo e use o mesmo marcador HEREDOC em todos os lugares:

<<'### BLOCK COMMENT'
line 1
line 2

line 3
line 4
### BLOCK COMMENT

A citação única do marcador HEREDOC evita alguns efeitos colaterais da análise de shell, como subsecções estranhas que causariam falha ou saída e até mesmo a análise do próprio marcador. Portanto, as aspas simples oferecem mais liberdade no marcador de comentário de abertura / fechamento. Por exemplo, o seguinte usa um hash triplo, que sugere um comentário de várias linhas no bash. Isso travaria o script se as aspas simples estivessem ausentes. Mesmo que você o remova ###, FOO{}ele travaria o script (ou causaria uma substituição incorreta, se não houver set -e), se não fossem as aspas simples:

set -e

<<'### BLOCK COMMENT'
something something ${FOO{}} something
more comment
### BLOCK COMMENT

ls

Você poderia, é claro, apenas usar

set -e

<<'###'
something something ${FOO{}} something
more comment
###

ls

mas a intenção disso é definitivamente menos clara para um leitor não familiarizado com esse truque.

Atualmente, qualquer bom editor permite que você pressione ctrl- / ou similar, para desmarcar / comentar a seleção. Todo mundo definitivamente entende isso:

# something something ${FOO{}} something
# more comment
# yet another line of comment

embora seja certo que isso não seja tão conveniente quanto o comentário em bloco acima, se você quiser preencher novamente seus parágrafos.

Certamente existem outras técnicas, mas não parece haver uma maneira "convencional" de fazê-lo. Seria bom se ###>e ###<pudesse ser adicionado ao bash para indicar o início e o fim do bloco de comentários, parece que poderia ser bem direto.

Depois de ler as outras respostas aqui, vim com o abaixo, que o IMHO deixa bem claro que é um comentário. Especialmente adequado para informações de uso no script:

<< ////

Usage:
This script launches a spaceship to the moon. It's doing so by 
leveraging the power of the Fifth Element, AKA Leeloo.
Will only work if you're Bruce Willis or a relative of Milla Jovovich.

////

Como programador, a sequência de barras é registrada imediatamente no meu cérebro como um comentário (mesmo que as barras sejam normalmente usadas para comentários de linha).

Claro, "////"é apenas uma string; o número de barras no prefixo e no sufixo deve ser igual.

qual a sua opinião sobre este?

function giveitauniquename()
{
  so this is a comment
  echo "there's no need to further escape apostrophes/etc if you are commenting your code this way"
  the drawback is it will be stored in memory as a function as long as your script runs unless you explicitly unset it
  only valid-ish bash allowed inside for instance these would not work without the "pound" signs:
  1, for #((
  2, this #wouldn't work either
  function giveitadifferentuniquename()
  {
    echo nestable
  }
}

Veja como eu faço comentários com várias linhas no bash.

Esse mecanismo tem duas vantagens que eu aprecio. Uma é que os comentários podem ser aninhados. A outra é que os blocos podem ser ativados simplesmente comentando a linha inicial.

#!/bin/bash
# : <<'####.block.A'
echo "foo {" 1>&2
fn data1
echo "foo }" 1>&2
: <<'####.block.B'
fn data2 || exit
exit 1
####.block.B
echo "can't happen" 1>&2
####.block.A

No exemplo acima, o bloco "B" é comentado, mas as partes do bloco "A" que não são o bloco "B" não são comentadas.

A execução desse exemplo produzirá esta saída:

foo {
./example: line 5: fn: command not found
foo }
can't happen

Tentei a resposta escolhida, mas descobri que, quando rodava um script de shell, a coisa toda estava sendo impressa na tela (semelhante à maneira como os cadernos jupyter imprimem tudo entre '''xx'''aspas) e havia uma mensagem de erro no final. Não estava fazendo nada, mas: assustador . Então, ao editar, percebi que aspas simples podem se estender por várias linhas. Então .. vamos apenas atribuir o bloco a uma variável.

x='
echo "these lines will all become comments."
echo "just make sure you don_t use single-quotes!"

ls -l
date

'

Solução simples, pouco inteligente:

Bloqueie temporariamente uma parte de um script:

if false; then
    while you respect syntax a bit, please
    do write here (almost) whatever you want.
    but when you are
    done # write
fi

Uma versão um pouco sofisticada:

time_of_debug=false # Let's set this variable at the beginning of a script

if $time_of_debug; then # in a middle of the script  
    echo I keep this code aside until there is the time of debug!
fi

# Eu gosto de preguiça e simplicidade. Eu usaria # com uma solução alternativa engraçada:

1 PRESSIONE:] encontre ctrl + F ou cmd + F ou o que for [para ativar a funcionalidade de localização

2 use uma regex no campo de localização, como: (^.+)

3 substitua por: # $1ou se você preferir#$1

# Nota: você pode não ter as três etapas no seu editor. Nesse caso, use uma ferramenta de regex online (não é possível sugerir uma aqui por motivos de política):

1. Selecione, copie o texto onde quer que esteja e cole-o na ferramenta regex online
2. Use (^.+)como regex e #$1ou #\1como padrões de substituição
3. Selecione, copie o texto e cole-o de volta onde você começou

# Aproveite seus hashes!