Comment créer des commentaires multilignes dans Bash?

J'ai récemment commencé à étudier le script shell et j'aimerais pouvoir commenter un ensemble de lignes dans un script shell. Je veux dire comme c'est le cas en C / Java:

/* comment1
   comment2 
   comment3
*/`

Comment pourrais-je faire ça?

Utilisez : 'pour ouvrir et 'fermer.

Par exemple:

: '
This is a
very neat comment
in bash
'

Commentaire multiligne dans 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

Je mets à jour ce message en fonction des commentaires et autres réponses, donc les commentaires avant le 22 mai 2020 peuvent ne plus s'appliquer.

Bash ne fournit pas de syntaxe intégrée pour les commentaires sur plusieurs lignes, mais il existe des hacks utilisant la syntaxe bash existante qui "fonctionnent maintenant".

Personnellement, je pense que le plus simple (c'est-à-dire le moins bruyant, le moins bizarre, le plus facile à taper, le plus explicite) est d'utiliser un HEREDOC cité, mais de rendre évident ce que vous faites, et d'utiliser le même marqueur HEREDOC partout:

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

line 3
line 4
### BLOCK COMMENT

Les guillemets simples du marqueur HEREDOC évitent certains effets secondaires d'analyse du shell, tels que des substitutions étranges qui provoqueraient un plantage ou une sortie, et même une analyse du marqueur lui-même. Ainsi, les guillemets simples vous donnent plus de liberté sur le marqueur de commentaire d'ouverture-fermeture. Par exemple, ce qui suit utilise un hachage triple qui suggère un commentaire sur plusieurs lignes dans bash. Cela ferait planter le script si les guillemets simples étaient absents. Même si vous supprimez ###, le FOO{}ferait planter le script (ou entraînerait une mauvaise substitution à imprimer si non set -e) s'il n'y avait pas les guillemets simples:

set -e

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

ls

Vous pouvez bien sûr simplement utiliser

set -e

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

ls

mais l'intention de ceci est certainement moins claire pour un lecteur peu familier avec cette supercherie.

De nos jours, tout bon éditeur vous permet d'appuyer sur ctrl- / ou similaire, pour annuler / commenter la sélection. Tout le monde comprend certainement cela:

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

même s'il est vrai que cela n'est pas aussi pratique que le commentaire de bloc ci-dessus si vous souhaitez remplir à nouveau vos paragraphes.

Il existe sûrement d'autres techniques, mais il ne semble pas y avoir de méthode «conventionnelle». Ce serait bien si ###>et ###<pouvait être ajouté à bash pour indiquer le début et la fin du bloc de commentaires, il semble que cela pourrait être assez simple.

Après avoir lu les autres réponses ici, j'ai trouvé ci-dessous, à mon humble avis, il est vraiment clair que c'est un commentaire. Particulièrement adapté aux informations d'utilisation dans le 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.

////

En tant que programmeur, la séquence de barres obliques s'inscrit immédiatement dans mon cerveau en tant que commentaire (même si les barres obliques sont normalement utilisées pour les commentaires de ligne).

Bien sûr, "////"c'est juste une chaîne; le nombre de barres obliques dans le préfixe et le suffixe doit être égal.

quelle est votre opinion sur celui-ci?

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

Voici comment je fais des commentaires multilignes en bash.

Ce mécanisme présente deux avantages que j'apprécie. La première est que les commentaires peuvent être imbriqués. L'autre est que les blocs peuvent être activés en commentant simplement la ligne de départ.

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

Dans l'exemple ci-dessus, le bloc "B" est commenté, mais les parties du bloc "A" qui ne sont pas le bloc "B" ne sont pas commentées.

L'exécution de cet exemple produira cette sortie:

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

J'ai essayé la réponse choisie, mais j'ai découvert que lorsque j'exécutais un script shell, le tout était imprimé à l'écran (similaire à la façon dont les cahiers jupyter imprimaient tout entre '''xx'''guillemets) et il y avait un message d'erreur à la fin. Il ne faisait rien, mais: effrayant . Puis j'ai réalisé en le modifiant que les guillemets simples pouvaient s'étendre sur plusieurs lignes. Donc .. laisse simplement assigner le bloc à une variable.

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

ls -l
date

'

Solution simple, pas très intelligente:

Bloquer temporairement une partie d'un 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

Une version un peu sophistiquée:

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

# J'aime la paresse et la simplicité. J'utiliserais # avec une solution de contournement amusante:

1 APPUYEZ SUR:] rechercher ctrl + F ou cmd + F ou autre [pour déclencher la fonctionnalité de recherche

2 utilisez une expression régulière dans le champ de recherche comme: (^.+)

3 remplacer par: # $1ou si vous préférez#$1

# Remarque: vous ne pouvez pas avoir les trois étapes dans votre éditeur. Dans ce cas, utilisez un outil d'expression régulière en ligne (ne pouvez pas en suggérer un ici pour des raisons de politique):

1. Sélectionnez, copiez le texte où que vous soyez et collez-le dans l'outil d'expression régulière en ligne
2. Utiliser (^.+)comme regex et #$1ou #\1comme modèles de substitution
3. Sélectionnez, copiez le texte et collez-le là où vous avez commencé

# Profitez de vos hachages!