Android

Skrive kommentarer i bask-manus

Команда AWK bash скрипты по-взрослому.

Команда AWK bash скрипты по-взрослому.

Innholdsfortegnelse:

Anonim

Når du skriver Bash-manus, er det alltid en god praksis å gjøre koden ren og lett forståelig. Å organisere koden din i blokker, innrykk, gi variabler og funksjoner beskrivende navn er flere måter å gjøre dette på.

En annen måte å forbedre lesbarheten til koden din er ved å bruke kommentarer. En kommentar er en menneskelig lesbar forklaring eller merknad som er skrevet i skallskriptet.

Å legge til kommentarer til Bash-skriptene dine vil spare deg for mye tid og krefter når du ser på koden din i fremtiden. La oss si at du vil endre et manus som du skrev for noen måneder eller år siden. Sjansen er stor for at du ikke kommer til å huske hvorfor du skrev et komplisert kodeverk med mindre du la til en kommentar.

Kommentarene hjelper også andre utviklere og systemadministratorer som kan trenge å vedlikeholde skriptet for å forstå koden din og dens formål.

Kommentarer brukes vanligvis for å forklare hva koden ikke kan. Hvis du for eksempel har en kompleks regex- eller parameterutskiftning i Bash-skriptet, bør du skrive en kommentar om hva koden gjør. Kommentarer skal være korte og til poenget. Ikke forklar noe som er enkelt og opplagt for leseren.

, vil vi dekke det grunnleggende for å skrive kommentarer i Bash.

Skrive kommentarer i Bash

Bash ignorerer alt som er skrevet etter hasjmerket ( # ) på linjen. Det eneste unntaket fra denne regelen er når den første linjen på skriptet starter med #! tegn. Denne sekvensen med tegn kalles Shebang og brukes til å fortelle operativsystemet hvilken tolk som skal brukes for å analysere resten av filen.

Kommentarer kan legges til i begynnelsen på linjen eller på linje med annen kode:

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

Det tomme rommet etter hasjmerket er ikke obligatorisk, men det vil forbedre kommentarens lesbarhet.

Vanligvis, når skriptet åpnes i en tekstredigerer, er kommentarer representert med grønt.

Kommentarer er også nyttige når du tester et skript. I stedet for å slette noen linjer eller blokker, kan du kommentere dem:

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

Multiline-kommentarer i Bash

I motsetning til de fleste programmeringsspråk, støtter ikke Bash multiline-kommentarer.

Den enkleste måten å skrive multiline-kommentarer i Bash er å legge til enkeltkommentarer etter hverandre:

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

Et annet alternativ er å bruke HereDoc. Det er en type omdirigering som lar deg sende flere linjer med input til en kommando. Hvis HereDoc-blokken ikke blir omdirigert til en kommando, kan den fungere som en plassering av flere linjer:

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

Å bruke HereDoc er et hack, ikke en skikkelig innebygd måte å skrive flerlinje Bash-kommentarer. For å unngå problemer, bør du foretrekke å bruke kommentarer på en linje.

Konklusjon

Å skrive kommentarer er en god praksis og hjelper andre utviklere, inkludert fremtidig selv, til å forstå skallskriptet. I Bash regnes alt etter hasjmerket ( # ) og til slutten av linjen som en kommentar.

Hvis du har spørsmål eller tilbakemeldinger, kan du gjerne legge igjen en kommentar.

bash terminal