Når du skriver Bash-scripts, er det altid en god praksis at gøre din kode ren og let forståelig. Organisering af din kode i blokke, angivelse af variabler og funktioner beskrivende navne er flere måder at gøre dette på.
En anden måde at forbedre læsbarheden af din kode er ved at bruge kommentarer. En kommentar er en menneskelig læsbar forklaring eller kommentar, der er skrevet i shell-scriptet.
Tilføjelse af kommentarer til dine Bash-scripts sparer dig meget tid og kræfter, når du ser på din kode i fremtiden. Lad os sige, at du vil ændre et script, som du skrev for et par måneder eller år siden. Chancerne er store, at du ikke kan huske, hvorfor du skrev et kompliceret stykke kode, medmindre du tilføjede en kommentar.
Kommentarerne hjælper også andre udviklere og systemadministratorer, der muligvis skal vedligeholde scriptet for at forstå din kode og dens formål.
Kommentarer bruges normalt til at forklare, hvad koden ikke kan. For eksempel, hvis du har en kompleks regex- eller parameterudskiftning i dit Bash-script, skal du skrive en kommentar om, hvad koden gør. Kommentarer skal være korte og til det punkt. Forklar ikke noget, der er enkelt og indlysende for læseren.
Bash ignorerer alt, hvad der er skrevet efter hash-mærket (#) på linjen. Den eneste undtagelse fra denne regel er, når den første linje på scriptet starter med #! tegn. Denne sekvens af tegn kaldes Shebang og bruges til at fortælle operativsystemet, hvilken tolk der skal bruges til at analysere resten af filen.
# This is a Bash comment.
$ echo "This is Code"
Flere linjers-kommentarer i Bash
I modsætning til de fleste programmeringssprog understøtter Bash ikke kommentarer over flere linjer.
Den enkleste måde at skrive multiline-kommentarer i Bash er at tilføje enkeltkommentarer efter hinanden:
# Dette er den første linje.
# Dette er den anden linje.
