Introduction
Les commentaires dans les scripts bash, et en programmation en général, permettent de rendre un programme plus compréhensible. Lorsqu’un programme s’exécute, l’interpréteur ignore les lignes commentées. Cependant, les commentaires aident à améliorer la lisibilité globale du programme.
Lorsque vous examinez le code plus tard, il est utile d’avoir des explications descriptives et précieuses sur ce que fait le code. Commenter le code pour une utilisation ultérieure est une pratique courante et essentielle en programmation et en scripting bash.
Ce tutoriel vous montre comment utiliser les commentaires et les meilleures pratiques de commentaires dans les scripts bash.
Prérequis
- Un système fonctionnant sous Linux.
- Accès à la ligne de commande/terminal.
- Un éditeur de texte, tel que Vi/Vim.
Commenter en Bash
Lors de l’écriture de scripts bash, tout texte après un signe dièse (#) indique le début d’un commentaire, et tout texte après # dans la même ligne n’est pas exécuté.
Lors de l’utilisation d’un éditeur de texte ou d’un IDE, les commentaires sont colorés différemment du reste du code. Ils sont faciles à repérer et à rechercher dans les codes plus longs.
L’exception est le shebang (#!), qui se trouve généralement à la première ligne du script. Le shebang indique au système d’exploitation quel interpréteur utiliser pour le code.
Les commentaires en ligne après le shebang entraînent une erreur “No such file or directory” (Fichier ou répertoire introuvable).
Commentaire sur une seule ligne et commentaires en ligne
Les commentaires sur une seule ligne et les commentaires en ligne dans les scripts bash commencent tous deux par le signe dièse (#):
# Ceci est un commentaireL’espace supplémentaire après le signe n’est pas nécessaire. Cependant, il améliore la lisibilité.
Suivez l’exemple ci-dessous pour créer un script avec des commentaires :
- Ouvrez le terminal (CTRL+ALT+T) et créez un script en utilisant Vi :
vi comment.sh- Ajoutez le code suivant :
# Un commentaire est considéré comme une seule ligne si vous n'appuyez pas sur Entrée.
# Voici le shebang, indiquant que le script utilise le shell bash.
#!/bin/bash
# Ceci est un commentaire sur une seule ligne au-dessus d'une commande.
echo "Bonjour le monde !" # Ceci est un commentaire en ligne.
# Ceci est un commentaire sur une seule ligne en dessous d'une commande.Le script comprend les lignes suivantes :
- La ligne 1 est un commentaire sur une seule ligne en bash. Visuellement, l’instruction s’étend sur deux lignes.
- La ligne 2 est le shebang. Le script s’exécute en utilisant l’interpréteur de shell bash, situé dans /bin/bash.
- Les lignes 3 et 5 sont également des commentaires sur une seule ligne avant et après une commande, respectivement.
- La ligne 4 est une simple commande echo avec un commentaire en ligne.
- Enregistrez et fermez Vi :
:wq- Modifiez les permissions du script pour qu’il soit exécutable :
chmod +x comment.sh- Enfin, exécutez le script avec :
./comment.shLes commentaires ne s’affichent pas lors de l’exécution du script.
Commentaire sur plusieurs lignes et commentaires de bloc
Pour créer des commentaires bash sur plusieurs lignes, commencez chaque ligne par le signe dièse (#):
# Ceci est la première ligne
# Ceci est la deuxième ligneUne autre façon non conventionnelle de créer des commentaires de bloc sur plusieurs lignes consiste à utiliser la commande null bash (:) avec la notation heredoc :
: << 'COMMENT'
Ceci est la première ligne
Ceci est la deuxième ligne
COMMENTFondamentalement, bash ne prend pas en charge les commentaires de bloc. Cette méthode fonctionne comme une astuce si un commentaire de bloc est nécessaire pour un cas spécifique.
Essayez l’exemple ci-dessous pour voir comment les commentaires sur plusieurs lignes et les commentaires de bloc fonctionnent dans les scripts bash :
- Ouvrez le terminal (CTRL+ALT+T) et créez un script shell en utilisant Vi :
vi multiline.sh- Copiez et collez le code suivant :
: << 'COMMENT'
Ceci est un commentaire de bloc sur plusieurs lignes en utilisant la notation heredoc avec des guillemets simples et la commande null bash.
COMMENT
echo "Bonjour le monde !" # Ceci est un commentaire sur plusieurs lignes en utilisant la notation d'une seule ligne.Le code fait ce qui suit :
- Les lignes 1 et 5 sont des délimiteurs heredoc.
- Les lignes 2 à 4 sont le contenu du commentaire de bloc.
- La ligne 6 est la commande
echo. - Les lignes 7 et 8 sont plusieurs commentaires sur une seule ligne, qui agissent comme des commentaires sur plusieurs lignes.
- Enregistrez le fichier et fermez Vi :
:wq- Modifiez les permissions du script pour qu’il soit exécutable :
chmod +x multiline.sh- Enfin, exécutez le script pour voir le résultat :
./multiline.shLa sortie du terminal ne montre que le résultat de la commande echo, tandis que les lignes commentées ne s’affichent pas.
Meilleures pratiques et conseils pour les commentaires en Bash
Bien qu’il n’y ait pas de règles spécifiques pour les commentaires en Bash, certaines pratiques sont utiles lors de l’utilisation de commentaires. Ces pratiques et ces conseils visent à vous aider à tirer le meilleur parti des commentaires dans les scripts bash.
1. Inclure un en-tête de fichier
Tous les scripts qui ne sont pas évidents au premier coup d’œil doivent inclure un en-tête de fichier. L’en-tête sert à plusieurs fins :
- Explique ce que fait le code en un coup d’œil.
- Indique l’auteur.
- Explique les notes de licence et fournit la déclaration de permission pour le code protégé par des droits d’auteur.
Utilisez des commentaires au début du code pour expliquer ces points. De plus, si un code fait partie d’un projet, incluez le nom du projet.
2. Éviter les commentaires de bloc non conventionnels
Bien que les commentaires de bloc soient possibles dans les scripts bash, il est déconseillé de les utiliser. Le code n’est pas aussi facilement repérable qu’un commentaire normal, car les éditeurs de texte ne les rendent pas comme des commentaires. De plus, la recherche est bien plus facile lorsqu’il existe une syntaxe de commentaire unifiée.
3. Éviter les commentaires longs et inutiles
Rendez les commentaires aussi courts que possible et concis. La verbosité est inutile et rend le code plus difficile à lire.
De même, ne commentez que le code qui est difficile à comprendre. Un commentaire sur une simple commande echo est inutile, tandis qu’un code qui utilise une expression régulière complexe nécessite une indication rapide de ce qu’il fait.
4. Commentaires et fonctions
Toutes les fonctions bash bénéficient de commentaires qui expliquent le but, les entrées attendues et les sorties. L’exception concerne les courts extraits de code qui sont évidents.
Indiquez les points suivants pour chaque fonction :
- Une brève description de l’opération.
- Une liste des variables globales ou modifiées.
- Les arguments d’entrée attendus.
- Ce que le processus affiche dans le terminal.
- Les valeurs de retour attendues.
Voici un exemple de fonction qui documente chacun des points précédents :
PREFIX="Bonjour " #### DÉBUT DE LA FONCTION
# Affiche une salutation
# GLOBAUX :
# PREFIX
# ARGUMENTS :
# Nom sous forme de chaîne à utiliser pour la salutation
# SORTIES :
# Écrit la chaîne sur STDOUT
# RETOUR :
# 0 en cas de succès, autrement non nul.
### FIN DE LA FONCTION
function () {
echo "${PREFIX}: $1!"
}Adaptez l’exemple à votre cas d’utilisation.
5. Étiqueter de manière cohérente
Utilisez des commentaires pour étiqueter le code qui nécessite une amélioration, une mise en œuvre ou une modification. Créez une étiquette de commentaire cohérente pour une tâche différente afin de faciliter la recherche dans les commentaires.
Par exemple, commencez et terminez chaque explication de fonction avec # DÉBUT DE LA FONCTION, ou ajoutez des commentaires # TODO pour les tâches futures. De même, décidez quels labels semblent appropriés et restez cohérent tout au long du code.
Conclusion
Après avoir lu ce tutoriel, vous savez maintenant comment écrire des commentaires en bash. Suivez les conseils et les meilleures pratiques pour utiliser efficacement les commentaires bash dans vos scripts.
