Comment créer des commentaires multilignes en Bash ?

Question

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

/* comment1
   comment2 
   comment3
*/`

Comment pourrais-je faire ça ?

Answer 1

Utilisez : ' pour ouvrir et ' pour fermer.

Par exemple :

: '
This is a
very neat comment
in bash
'

Answer 2

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

Answer 3

Bash ne fournit pas de module intégré, mais il existe des astuces utilisant la syntaxe bash existante. Le plus simple est d'utiliser un HEREDOC, mais de rendre évident ce que vous faites, et d'utiliser le même marqueur HEREDOC partout :

<< --MULTILINE-COMMENT--
line 1
line 2

line 3
line 4
--MULTILINE-COMMENT--

Certains messages mentionnent que le marqueur HEREDOC doit être cité afin d'éviter certains effets secondaires de l'analyse du shell. Je n'ai trouvé cela nécessaire que si vous utilisez des guillemets dans votre commentaire. Même avec set -o verbose et $variables mentionné dans le commentaire, la citation du marqueur n'est pas nécessaire. YMMV.

Si vous utilisez le : ' mentionnée dans une autre réponse, alors documentez ce qu'il en est via un méta-commentaire, utilisez le même méta-commentaire partout et n'oubliez pas de doubler toutes les occurrences de ' dans le commentaire (un éditeur de coloration syntaxique le rendra évident) :

: 'Multiline comment:
line 1
line 2 we''re going to try this eventually
line 3
'

Les deux sont des hacks, ils pourraient donc casser des scripts à l'avenir.

Il existe sûrement d'autres techniques, mais il ne semble pas y avoir de manière "conventionnelle" de le faire.

Answer 4

Après avoir lu les autres réponses ici, j'ai trouvé le texte ci-dessous, qui, à mon avis, indique clairement qu'il s'agit d'un commentaire. Particulièrement adapté pour les informations d'utilisation 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.

////

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

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

Answer 5

Quelle est votre opinion sur ce sujet ?

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