Pisanje komentara bash skriptama

Kada pišete Bash skripte, uvijek je dobra praksa da vaš kôd bude čist i lako razumljiv. Organiziranje koda u blokove, uvlačenje uzoraka, davanje varijabli i opisnih imena funkcija je nekoliko načina za to.

Drugi način za poboljšanje čitljivosti vašeg koda je korištenjem komentara. Komentar je ljudsko razumljivo objašnjenje ili napomena koji su zapisani u skriptu ljuske.

Dodavanjem komentara u Bash skripte uštedjet ćete puno vremena i truda kad gledate kôd u budućnosti. Recimo da želite promijeniti scenarij koji ste napisali prije nekoliko mjeseci ili godina. Velike su šanse da se nećete sjetiti zašto ste napisali neki komplicirani dio koda ukoliko niste dodali komentar.

Komentari pomažu i drugim programerima i administratorima sustava koji će možda trebati održavati skriptu kako bi razumjeli vaš kôd i njegovu svrhu.

Komentari se obično koriste za objašnjenje onoga što kôd ne može. Na primjer, ako imate složeni regex ili zamjenu parametara unutar vaše Bash skripte, trebali biste napisati komentar o tome što radi kod. Komentari trebaju biti kratki i jasni. Ne objašnjavajte nešto što je čitatelju jednostavno i očito.

, pokrit ćemo osnove pisanja komentara u Bashu.

Pisanje komentara na Bashu

Bash ignorira sve što piše nakon oznake hash-a ( # ) na crti. Jedina iznimka od ovog pravila je kada prvi redak skripte započinje s #! znakova. Taj se niz znakova zove Shebang i koristi se da bi operativnom sustavu rekao koji interpreter treba koristiti za analizu ostatka datoteke.

Komentari se mogu u početku dodavati na liniji ili liniju s drugim kodom:

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

Prazan prostor nakon oznake hash-a nije obvezan, ali će poboljšati čitljivost komentara.

Obično kada se skripta otvori u uređivaču teksta, komentari su predstavljeni zelenom bojom.

Komentari su također korisni pri testiranju skripte. Umjesto brisanja nekih redaka ili blokova, možete ih komentirati:

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

Multiline komentari u Bashu

Za razliku od većine programskih jezika, Bash ne podržava komentare s više linija

Najjednostavniji način pisanja višelinijskih komentara u Bashu je dodavanje pojedinačnih komentara jedan za drugim:

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

Druga je mogućnost upotrebe HereDoc-a. To je vrsta preusmjeravanja koja vam omogućuje da u naredbu proslijedite više linija unosa. Ako blok HereDoc nije preusmjeren na naredbu, može poslužiti kao zamjenski zamjenjivač višeslojnih komentara:

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

Upotreba HereDoc-a je hack, a ne pravi ugrađeni način pisanja višelinijskih Bash komentara. Da biste izbjegli bilo kakve probleme, radije koristite jednoredne komentare.

Zaključak

Pisanje komentara dobra je praksa i pomaže drugim programerima, uključujući buduće vlastite osobe, da razumiju skriptu školjke. U Bashu se sve nakon oznake hash-a ( # ) i do kraja retka smatra komentarom.

Ako imate bilo kakvih pitanja ili povratnih informacija, slobodno ostavite komentar.

bash terminal