Scrierea comentariilor în scripturile bash

Când scrieți scripturi Bash, este întotdeauna o practică bună să faceți codul dvs. curat și ușor de înțeles. Organizarea codului dvs. în blocuri, indentare, oferirea de variabile și funcții nume descriptive sunt mai multe modalități de a face acest lucru.

Un alt mod de a îmbunătăți lizibilitatea codului dvs. este folosind comentarii. Un comentariu este o explicație sau o adnotare care poate fi citită de om care este scrisă în scriptul shell.

Adăugarea de comentarii la scripturile dvs. Bash vă va economisi mult timp și efort atunci când priviți codul dvs. în viitor. Să spunem că doriți să schimbați un script pe care l-ați scris acum câteva luni sau ani. Șansele sunt să nu vă amintiți de ce ați scris o bucată de cod complicată decât dacă ați adăugat un comentariu.

Comentariile ajută și alți dezvoltatori și administratori de sistem care ar putea avea nevoie să mențină scriptul pentru a înțelege codul și scopul acestuia.

Comentariile sunt de obicei folosite pentru a explica ce nu poate codul. De exemplu, dacă aveți o regex complexă sau o înlocuire a parametrilor în scriptul Bash, ar trebui să scrieți un comentariu despre ceea ce face codul. Comentariile ar trebui să fie scurte și la obiect. Nu explicați ceva care este simplu și evident pentru cititor.

, vom aborda elementele de bază ale scrierii comentariilor în Bash.

Scrierea comentariilor în Bash

Bash ignoră tot ceea ce este scris după marcajul de hash ( # ) de pe linie. Singura excepție de la această regulă este atunci când prima linie din script începe cu #! de caractere. Această secvență de caractere se numește Shebang și este folosită pentru a spune sistemului de operare ce interpret să folosească pentru a analiza restul fișierului.

Comentariile pot fi adăugate la început pe linie sau în linie cu un alt cod:

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

Spațiul gol după marcajul hash nu este obligatoriu, dar va îmbunătăți lizibilitatea comentariului.

De obicei, când scriptul este deschis într-un editor de text, comentariile sunt reprezentate în verde.

Comentariile sunt utile și la testarea unui script. În loc să ștergeți câteva linii sau blocuri, le puteți comenta:

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

Comentarii multiline în Bash

Spre deosebire de majoritatea limbajelor de programare, Bash nu acceptă comentarii multiline.

Cel mai simplu mod de a scrie comentarii multiline în Bash este să adăugați comentarii unice una după alta:

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

O altă opțiune este utilizarea HereDoc. Este un tip de redirecție care vă permite să treceți mai multe linii de intrare la o comandă. În cazul în care blocul HereDoc nu este redirecționat către o comandă, poate servi ca un locomotor pentru comentarii multiline:

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

Utilizarea HereDoc este un hack, nu o modalitate reală de a scrie comentarii Bash multiline. Pentru a evita orice probleme, ar trebui să preferați să folosiți comentarii cu o singură linie.

Concluzie

Scrierea de comentarii este o practică bună și ajută alți dezvoltatori, inclusiv viitorii auto, să înțeleagă scriptul shell. În Bash, totul după marcajul hash ( # ) și până la sfârșitul liniei este considerat un comentariu.

Dacă aveți întrebări sau feedback, nu ezitați să lăsați un comentariu.

terminalul bash