Android

Skrivning af kommentarer i bash-scripts

SRP skrivning og ny PR!

SRP skrivning og ny PR!

Indholdsfortegnelse:

Anonim

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, indrykk, 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 husker, 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.

, vil vi dække det grundlæggende ved at skrive kommentarer i Bash.

Skrivning af kommentarer i Bash

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 rækkefølge af tegn kaldes Shebang og bruges til at fortælle operativsystemet, hvilken tolk der skal bruges til at analysere resten af ​​filen.

Kommentarer kan tilføjes i begyndelsen på linjen eller inline med anden kode:

# This is a Bash comment. echo "This is Code" # This is an inline Bash comment.

Det tomme rum efter hash-mærket er ikke obligatorisk, men det vil forbedre kommentarens læsbarhed.

Når scriptet åbnes i en teksteditor, repræsenteres normalt kommentarer med grønt.

Kommentarer er også nyttige, når du tester et script. I stedet for at slette nogle linjer eller blokke, kan du kommentere dem:

# if]; then # echo "Variable is greater than 10." # fi

Multiline-kommentarer i Bash

I modsætning til de fleste programmeringssprog understøtter Bash ikke multiline-kommentarer.

Den enkleste måde at skrive multiline-kommentarer i Bash er at tilføje enkeltkommentarer efter hinanden:

# This is the first line. # This is the second line.

En anden mulighed er at bruge HereDoc. Det er en type omdirigering, der giver dig mulighed for at videregive flere inputlinjer til en kommando. Hvis HereDoc-blokken ikke omdirigeres til en kommando, kan den fungere som en pladsholder for flere linjer:

<< 'MULTILINE-COMMENT' Everything inside the HereDoc body is a multiline comment MULTILINE-COMMENT

Brug af HereDoc er et hack, ikke en rigtig indbygget måde at skrive multiline Bash-kommentarer på. For at undgå problemer skal du foretrække at bruge kommentarer på én linje.

Konklusion

Skrivning af kommentarer er en god praksis og hjælper andre udviklere, inklusive fremtidig selv, til at forstå shell-scriptet. I Bash betragtes alt efter hash-mærket ( # ) og indtil slutningen af ​​linjen som en kommentar.

Hvis du har spørgsmål eller feedback, er du velkommen til at give en kommentar.

bash terminal