Lors de l'écriture de scripts Bash, il est toujours recommandé de rendre votre code propre et facilement compréhensible. Organiser votre code en blocs, indenter, donner aux variables et aux fonctions des noms descriptifs sont plusieurs façons de le faire.
Une autre façon d'améliorer la lisibilité de votre code consiste à utiliser des commentaires. Un commentaire est une explication ou une annotation lisible par l'homme qui est écrite dans le script shell.
L'ajout de commentaires à vos scripts Bash vous fera gagner beaucoup de temps et d'efforts lorsque vous examinerez votre code à l'avenir. Supposons que vous souhaitiez modifier un script que vous avez écrit il y a quelques mois ou quelques années. Il y a de fortes chances que vous ne vous rappeliez pas pourquoi vous avez écrit un morceau de code compliqué à moins que vous n'ayez ajouté un commentaire.
Les commentaires aident également les autres développeurs et administrateurs système qui peuvent avoir besoin de maintenir le script pour comprendre votre code et son objectif.
Les commentaires sont utilisés pour expliquer le code. Par exemple, si vous avez une regex complexe ou une substitution de paramètre dans votre script Bash, vous devez écrire un commentaire décrivant ce que fait le code. Les commentaires doivent être courts et précis. N'expliquez pas quelque chose qui est simple et évident pour le lecteur.
Dans cet article, nous aborderons les bases de la rédaction de commentaires dans Bash.
Écrire des commentaires dans Bash #
Bash ignore tout ce qui est écrit sur la ligne après le signe dièse (# ). La seule exception à cette règle est lorsque la première ligne du script commence par #! personnages. Cette séquence de caractères est appelée Shebang et est utilisée pour indiquer au système d'exploitation quel interpréteur utiliser pour analyser le reste du fichier.
Les commentaires peuvent être ajoutés au début de la ligne ou en ligne avec un autre code :
# This is a Bash comment.
echo "This is Code" # This is an inline Bash comment.
L'espace vide après le dièse n'est pas obligatoire, mais il améliorera la lisibilité du commentaire.
Si votre éditeur de texte prend en charge la coloration syntaxique, les commentaires sont généralement représentés en vert.
Les commentaires sont également utiles lors du test d'un script. Au lieu de supprimer certaines lignes ou certains blocs, vous pouvez les commenter :
# if [[ $VAR -gt 10 ]]; then
# echo "Variable is greater than 10."
# fi
Commentaires multilignes dans Bash #
Contrairement à la plupart des langages de programmation, Bash ne prend pas en charge les commentaires multilignes.
La façon la plus simple d'écrire des commentaires multilignes dans Bash est d'ajouter des commentaires simples les uns après les autres :
# This is the first line.
# This is the second line.
Une autre option consiste à utiliser HereDoc. C'est un type de redirection qui vous permet de passer plusieurs lignes d'entrée à une commande. Si le bloc HereDoc n'est pas redirigé vers une commande, il peut servir d'espace réservé pour les commentaires multilignes :
<< 'MULTILINE-COMMENT'
Everything inside the
HereDoc body is
a multiline comment
MULTILINE-COMMENT
Utiliser HereDoc est un hack, pas un véritable moyen intégré d'écrire des commentaires Bash multilignes. Pour éviter tout problème, il est préférable d'utiliser des commentaires sur une seule ligne.
Conclusion #
Écrire des commentaires est une bonne pratique et aide les autres développeurs, y compris les futurs développeurs, à comprendre le script shell. Dans Bash, tout ce qui suit le signe dièse (# ) et jusqu'à la fin de la ligne est considérée comme un commentaire.
Si vous avez des questions ou des commentaires, n'hésitez pas à laisser un commentaire.