Ajouter des commentaires dans les scripts Bash : simples, multiples et en ligne

Avez-vous des commentaires? Ajoutez-les à votre script bash ;)

L'ajout de commentaires dans les scripts bash est l'un des moyens les plus efficaces de garder votre code propre et compréhensible.

Vous pouvez demander pourquoi.

Supposons que votre script contienne une expression régulière complexe ou plusieurs blocs de codes complexes et dans ce cas, vous pouvez ajouter des commentaires pour que d'autres développeurs puissent avoir une idée de ce que ce bloc de code était censé être.

Commenter une partie du code aide également au débogage des scripts.

Dans ce tutoriel, je vais vous présenter trois façons d'ajouter des commentaires dans les scripts bash :

Commentaires sur une seule ligne
Commentaires en ligne
Commentaires sur plusieurs lignes

Alors commençons par le premier.

Commentaires sur une seule ligne dans bash

Pour ajouter des commentaires sur une seule ligne, vous devez mettre le hashtag (#) au début de la ligne et rédiger un commentaire.

Voici un exemple simple :

#!/bin/bash
# This is a comment
echo "Hello, World!"

Lors de l'exécution, les commentaires seront ignorés et lorsque j'ai exécuté la commande ci-dessus, cela ressemblait à ceci :

💡

La seule exception à la règle # pour commentaire est la ligne #!/bin/bash au début des scripts. Cela s'appelle shebang et sert à spécifier l'interpréteur à utiliser lors de l'exécution du script. Il existe différents shells et la syntaxe peut différer. Une bonne pratique consiste donc à spécifier pour quel shell le script a été écrit. Par exemple, si c'était pour ksh, vous utiliseriez #!/bin/ksh

Commentaires en ligne dans les scripts bash

Alternativement, vous pouvez placer le commentaire dans le bloc de code pour documenter le but de cette ligne spécifique.

🚧

Tout ce qui suit # ne sera pas exécuté avant la fin de la ligne, alors assurez-vous d'ajouter le commentaire à la fin du code.

Voici un exemple simple :

#!/bin/bash
echo "Hello, World!" #Prints hello world

Commentaires multilignes en bash

🚧

Il n'y a pas de fonctionnalité de commentaire multiligne intégrée dans Bash. Cependant, il existe quelques solutions pour obtenir l'effet de commentaire multiligne.

Comme leur nom l'indique, les commentaires multilignes dans les scripts bash vous permettent d'écrire des commentaires sur plusieurs lignes ou d'empêcher l'exécution d'un bloc de code en les plaçant dans une section de commentaires multiligne :

Utilisez # au début de chaque ligne
Notation deux-points (utilise deux points suivis d'un guillemet simple)
Ici document (utilise << suivi d'un délimiteur)

Alors commençons par le premier.

1. Utilisez # pour chaque ligne de commentaire de bloc

C'est ce que je suggère d'utiliser si votre objectif est d'expliquer une partie du script. Après tout, # est la véritable fonction de commentaire.

Et c’est aussi ce que de nombreux développeurs utilisent.

Supposons que vous deviez expliquer au début le but du script, les informations sur l'auteur ou les informations sur la licence. Vous pouvez l'écrire comme ceci :

#!/bin/bash

######################################
## This script is used for scanning ##
## local network                    ##
## Licensed under GPL 2.0           ##
######################################

rest of the bash script code

C'est bien quand vous savez comment se comporte votre script bash. Si vous déboguez un script bash et souhaitez masquer une partie du script, ajouter # au début de chaque ligne du code requis, puis les supprimer après le débogage est une tâche fastidieuse.

Les deux sections suivantes vous y aident.

2. Notation par deux points

Pour utiliser la notation deux-points, vous écrivez des commentaires de bloc entre : ' et le ' de fermeture comme indiqué ici :

#!/bin/bash

: '
This is how you can use colon notation
And this line too will be ignored
'
echo "GOODBYE"

Lorsque vous exécutez le script ci-dessus, il ne doit imprimer que GOODBYE :

2. Ici le document

C'est de loin la manière la plus populaire d'écrire des commentaires multilignes en bash que vous utilisez << suivi d'un délimiteur (un ensemble de caractères pour spécifier le début et la fin des commentaires).

Voici comment l'utiliser :

#!/bin/bash

<<DELIMITER
Comment line 1
Comment line 2
DELIMITER

echo "Hello, World!"

Encore confus? Voici un exemple simple :

#!/bin/bash

<<COMMENT
This is a multi-line comment using a here document.
You can add as many lines as you want between <<COMMENT and the terminating keyword.
This block won't be executed by the shell.
COMMENT

echo "Hello, World!"

Dans l'exemple ci-dessus, j'ai utilisé COMMENT comme délimiteur, mais vous pouvez utiliser n'importe quoi, mais assurez-vous qu'il se démarque du commentaire, sinon cela créera de la confusion.

Lorsque j'ai exécuté le script ci-dessus, il m'a donné le résultat suivant :

Comme vous pouvez le voir, il a tout ignoré à l'intérieur de <

Apprenez le bash à partir de zéro !!

Si vous envisagez d'apprendre bash à partir de zéro ou si vous souhaitez parcourir toutes les bases, nous avons rédigé un guide détaillé pour vous :

J'espère que vous trouverez ce guide utile.