Comment écrire des commentaires dans les scripts Bash

Eh bien, vous avez écrit un script Bash génial. Cela fonctionne parfaitement et il n’est peut-être pas nécessaire d’ajouter de nouvelles fonctionnalités. Enfin, peut-être pas pour l’instant, du moins ! À ce stade, vous êtes satisfait du scénario. Cependant, après quelques mois, vous rouvrez votre script bash pour ajouter de nouvelles fonctionnalités et vous avez mal à la tête pour comprendre comment le script fonctionne réellement. Par conséquent, vous devez dépenser de l’énergie et du temps supplémentaires avant de pouvoir commencer à modifier le script afin d’ajouter de nouvelles fonctionnalités.

Eh bien, à ce stade, vous regrettez de ne pas avoir mis quelques commentaires (notes) dans le script pour vous rappeler comment le script bash est structuré. Non seulement les commentaires Bash sont d’excellentes notes pour vous ou toute autre personne qui pourrait travailler avec votre script, mais ils peuvent également être utilisés dans une certaine mesure comme un outil de débogage de script bash de base.

Dans ce tutoriel, vous allez apprendre :

• Comment commenter sur la ligne de commande bash
• Comment écrire des scripts bash de commentaires
• Comment créer plusieurs commentaires de ligne

Exemple de commentaire de script Bash

Configuration logicielle requise et conventions utilisées

Comment écrire des commentaires dans les scripts Bash

L’explication la plus simple sur la façon d’insérer un commentaire dans un script bash est de dire que toute ligne, à l’exception de la première ligne préfixée par le #, est considérée comme un commentaire par l’interpréteur bash. Comme la même règle s’applique également à une commande bash, vous pouvez tester cette définition en préfixant simplement n’importe quelle commande que vous utilisez pour qu’elle s’exécute sur le terminal de l’interpréteur de commandes bash. Par exemple, essayez d’exécuter les commandes suivantes :

echo "Bash Comment"
# echo "Bash Comment"

Comme vous pouvez le voir, la deuxième commande a été ignorée par l’interpréteur Bash car elle a été interprétée comme un commentaire. Le commentaire des commandes bash est un excellent moyen d’enregistrer vos commandes dans un historique bash sans l’exécution réelle.

Ensuite, essayez de créer un commentaire dans le script bash réel. Tout ce qu’il faut faire est de préfixer chaque ligne que vous souhaitez commenter avec #.

En voici un exemple :

#!/bin/bash

greeting="Welcome"
user=$(whoami)
day=$(date +%A)

echo "$greeting back $user! Today is $day, which is the best day of the entire week!"
echo "Your Bash shell version is: $BASH_VERSION. Enjoy!"

Ensuite, essayez de commenter certaines des lignes :

#!/bin/bash

#greeting="Welcome"
#user=$(whoami)
#day=$(date +%A)

echo "$greeting back $user! Today is $day, which is the best day of the entire week!"
echo "Your Bash shell version is: $BASH_VERSION. Enjoy!"

En fonction de votre surligneur de syntaxe, vous pouvez voir que les lignes commentées sont maintenant ignorées.

Malheureusement, bash ne permet pas de commenter l’ensemble du bloc. Au lieu de cela, si vous souhaitez bloquer les commentaires, vous devrez commenter chaque ligne une par une. Heureusement, de nombreux éditeurs de texte facilitent vos efforts.

Par exemple, l’utilisation de l’éditeur Kate vous permet de commenter plusieurs lignes à la fois en mettant simplement en surbrillance toutes les lignes requises en appuyant sur CTRL+d, raccourci CTRL+d. Pour annuler les commentaires, appuyez simplement sur CTRL+SHIFT+D.

Un autre exemple est un éditeur de texte VIM, comme le montre la vidéo ci-dessous :