Les commentaires font partie intégrante de tout langage de programmation ou de script. Bash n'est pas différent.
Comme tout langage de programmation, les commentaires en script bash sont utilisés pour rendre le code plus compréhensible. Vous pouvez également utiliser des commentaires pour ignorer une partie des codes lors du débogage de votre script.
Dans cette astuce bash, je vais vous montrer trois façons d'ajouter des commentaires dans votre script shell :
- Commentaire sur une seule ligne
- Commentaire intégré
- Commentaire multiligne
Commentaires sur une seule ligne dans le script bash
Toute ligne commençant par la touche dièse/dièse # est traitée comme un commentaire dans bash. La seule exception à cette règle est # ! qui est shebang et est utilisé pour indiquer quel shell utiliser pour traiter le script.
Voyons cela avec un exemple de script bash :
#!/bin/bash
#Define variables here
message="Hello"
day=$(date +%A)
#Print some messages
echo "$message $USER! It's $day today. Enjoy your day!"
echo "Goodbye for now!"Comme vous pouvez le voir, il y a deux commentaires sur une seule ligne dans l'exemple ci-dessus.
Commentaires en ligne dans le script bash
Vous pouvez également ajouter des commentaires en ligne dans les scripts bash. Au lieu de commencer la ligne par #, ajoutez le commentaire commençant par # à la fin de la ligne de code.
Voici un exemple :
#!/bin/bash
message="Hello"
day=$(date +%A) #This will print only the day, not entire date and time
echo "$message $USER! It's $day today. Enjoy your day!"
echo "Goodbye for now!"J'ai ajouté un commentaire en ligne dans la ligne où le jour variable a été déclaré. Cela vous indique que la commande de date avec +%A n'affichera que le jour actuel.
J'ai supprimé les autres commentaires pour éviter toute confusion.
Commentaires multilignes dans le script bash
Le commentaire multiligne ou de bloc dans bash n'est pas directement possible. Vous pouvez utiliser plusieurs commentaires sur une seule ligne, mais je sais que ce n'est pas très pratique, surtout lorsque vous devez décommenter tout le bloc de code.
Heureusement, il existe une solution de contournement pour commenter plusieurs lignes dans bash en utilisant here document. C'est une redirection pour fournir plusieurs lignes d'entrée à une commande. Lorsqu'il n'est redirigé vers aucune commande, il peut être utilisé pour ajouter des commentaires de bloc.
#!/bin/bash
<<Block_comment
message="Hello"
day=$(date +%A) #This will print only the day, not entire date and time
echo "$message $USER! It's $day today. Enjoy your day!"
Block_comment
echo "Goodbye for now!"
Si vous exécutez le script ci-dessus, il n'affichera que .Au revoir pour l'instant !'. Tout le code entre <
Si vous déboguez votre code et souhaitez commenter des blocs de code, vous pouvez l'utiliser. Sinon, évitez de l'utiliser dans vos scripts principaux car ce n'est pas une fonctionnalité intégrée du shell.
J'espère que vous aimez cette astuce rapide sur la rédaction de commentaires dans votre script shell. Vos questions et suggestions sont toujours les bienvenues.