Comment ajouter des commentaires dans les scripts Bash

Suraj Joshi 7 octobre 2020
  1. Commentaires d’une seule ligne en Bash
  2. Commentaires multi-lignes en Bash
Comment ajouter des commentaires dans les scripts Bash

Les commentaires sont les lignes que l’interprète ignore et sont juste utilisés pour décrire ce qui se passe dans le code ou donner un aperçu de ce que fait un bloc ou une ligne de code en particulier. Les commentaires rendent le code plus facile à comprendre pour ceux qui le lisent. Nous pouvons décrire ce qui se passe dans le code en langage humain à l’aide de commentaires. Cela peut également être utile lorsque nous révisons notre code après un certain temps de rédaction. Les commentaires sont également utiles lors du débogage du code. Au lieu de supprimer la partie soupçonnée d’avoir un bogue, nous pouvons commenter la partie en question et déboguer le code.

Nous pouvons écrire des commentaires en Bash en utilisant # et heredoc. Généralement, # est utilisé pour écrire des commentaires d’une seule ligne, et heredoc est utilisé pour écrire des commentaires de plusieurs lignes.

Commentaires d’une seule ligne en Bash

Nous utilisons des symboles # pour écrire des commandes à ligne unique en Bash. Après le #, tout est ignoré lors de l’interprétation du script, sauf la première ligne qui contient le #. Cette séquence spécifique qui apparaît sur la première ligne est appelée Shebang, et elle est utilisée pour décider quel interpréteur utiliser.

Les commentaires peuvent commencer au début de la ligne, ou peuvent même être en ligne avec le code.

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

Production:

Hello World!

Ici, la première ligne suggère que le compilateur à utiliser est /bin/bash.

À la deuxième ligne, nous avons le commentaire en ligne et à la troisième ligne, nous avons un commentaire commençant au début de la ligne.

Commentaires multi-lignes en Bash

Bash n’a pas de support pour les commentaires de plusieurs lignes. Une façon d’écrire des commentaires de plusieurs lignes dans Bash est d’utiliser un commentaire d’une seule ligne pour chaque ligne.

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

Production:

Hello World!

Ici, les lignes 1 et 2 peuvent être considérées comme des commentaires de plusieurs lignes où chaque ligne est interprétée comme un commentaire séparé par l’interprète.

On peut aussi profiter de Heredoc pour écrire des commandes multi-lignes. Heredoc est une méthode pour passer des entrées multi-lignes à une commande. Nous pouvons utiliser Heredoc comme un commentaire multi-lignes si le Heredoc n’est pas redirigé vers une commande.

#!/bin/bash

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

Production:

Hello World!

Ici, les lignes 3 à 7 sont considérées comme un commentaire multi-lignes par l’interpréteur.

Auteur: Suraj Joshi
Suraj Joshi avatar Suraj Joshi avatar

Suraj Joshi is a backend software engineer at Matrice.ai.

LinkedIn