Modo per creare commenti multilinea in Bash?

Di recente ho iniziato a studiare lo script di shell e mi piacerebbe poter commentare una serie di righe in uno script di shell. Voglio dire, è nel caso di C / Java:

/* comment1
   comment2 
   comment3
*/`

Come potrei farlo?

Utilizzare : 'per aprire e 'chiudere.

Per esempio:

: '
This is a
very neat comment
in bash
'

Commento multilinea in 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

Sto aggiornando questo post in base a commenti e altre risposte, quindi i commenti precedenti al 22 maggio 2020 potrebbero non essere più applicabili.

Bash non fornisce una sintassi integrata per i commenti su più righe ma ci sono hack che usano la sintassi bash esistente che "sembra funzionare ora".

Personalmente penso che il più semplice (cioè meno rumoroso, meno strano, più facile da digitare, più esplicito) sia usare un HEREDOC citato, ma rendere ovvio ciò che stai facendo e usare lo stesso marcatore HEREDOC ovunque:

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

line 3
line 4
### BLOCK COMMENT

La virgoletta singola del marcatore HEREDOC evita alcuni effetti collaterali dell'analisi shell, come strane sostituzioni che potrebbero causare arresti anomali o output e persino l'analisi del marcatore stesso. Quindi le virgolette singole ti danno più libertà sul marker di commento aperto-chiuso. Ad esempio, ciò che segue usa un triplo hash che suggerisce un commento multilinea in bash. Ciò causerebbe l'arresto anomalo dello script se le singole virgolette fossero assenti. Anche se lo rimuovessi ###, FOO{}si bloccherebbe lo script (o causerebbe la stampa di una sostituzione errata in set -ecaso contrario) se non fosse per le virgolette singole:

set -e

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

ls

Ovviamente potresti semplicemente usare

set -e

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

ls

ma l'intento è decisamente meno chiaro per un lettore che non ha familiarità con questo trucco.

Oggi qualsiasi buon editor ti consente di premere ctrl- / o simili, per annullare / commentare la selezione. Tutti lo capiscono sicuramente:

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

sebbene sia vero, ciò non è altrettanto conveniente del commento di blocco sopra se si desidera riempire nuovamente i paragrafi.

Esistono sicuramente altre tecniche, ma non sembra esserci un modo "convenzionale" per farlo. Sarebbe bello se ###>e ###<potesse essere aggiunto a bash per indicare l'inizio e la fine del blocco dei commenti, sembra che potrebbe essere piuttosto semplice.

Dopo aver letto le altre risposte qui ho trovato il seguito, che IMHO chiarisce davvero che è un commento. Particolarmente adatto per informazioni sull'utilizzo in-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.

////

Come programmatore, la sequenza di barre si registra immediatamente nel mio cervello come commento (anche se le barre vengono normalmente utilizzate per i commenti di linea).

Certo, "////"è solo una stringa; il numero di barre nel prefisso e nel suffisso deve essere uguale.

qual è la tua opinione su questo?

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
  }
}

Ecco come faccio commenti multilinea in bash.

Questo meccanismo ha due vantaggi che apprezzo. Uno è che i commenti possono essere nidificati. L'altro è che i blocchi possono essere abilitati semplicemente commentando la riga iniziale.

#!/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

Nell'esempio sopra il blocco "B" è commentato, ma le parti del blocco "A" che non sono il blocco "B" non sono commentate.

L'esecuzione di questo esempio produrrà questo output:

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

Ho provato la risposta scelta, ma ho scoperto che quando eseguivo uno script shell con esso, l'intera cosa veniva stampata sullo schermo (simile a come i quaderni di Giove stampavano tutto tra '''xx'''virgolette) e alla fine c'era un messaggio di errore. Non stava facendo nulla, ma: spaventoso . Poi mi sono reso conto durante la modifica che le virgolette singole possono estendersi su più righe. Quindi .. consente di assegnare il blocco a una variabile.

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

ls -l
date

'

Soluzione semplice, non molto intelligente:

Blocca temporaneamente una parte di uno 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

Una versione un po 'sofisticata:

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

# Mi piace la pigrizia e la semplicità. Userei # con una soluzione alternativa divertente:

1 PREMERE:] trova ctrl + F o cmd + F o qualsiasi altra cosa [per attivare la funzionalità di ricerca

2 usa un regex nel campo find come: (^.+)

3 sostituisci con: # $1o se preferisci#$1

# Nota: potresti non avere i tre passaggi nel tuo editor. In tal caso, utilizzare uno strumento regex online (non è possibile suggerire uno qui per motivi di politica):

1. Seleziona, copia il testo ovunque ti trovi e incollalo nello strumento regex online
2. Utilizzare (^.+)come regex e #$1o #\1come schemi di sostituzione
3. Seleziona, copia il testo e incollalo nel punto in cui hai iniziato

# Goditi i tuoi hash!