Pisanie komentarzy w skryptach bash

Podczas pisania skryptów Bash dobrą praktyką jest sprawienie, aby kod był czysty i łatwy do zrozumienia. Organizowanie kodu w bloki, wcięcie, nadawanie zmiennym i funkcyjnym nazwom opisowym to kilka sposobów.

Innym sposobem na poprawienie czytelności kodu jest użycie komentarzy. Komentarz jest czytelnym dla człowieka objaśnieniem lub adnotacją zapisaną w skrypcie powłoki.

Dodanie komentarzy do skryptów Bash pozwoli Ci zaoszczędzić dużo czasu i wysiłku, kiedy spojrzysz na swój kod w przyszłości. Powiedzmy, że chcesz zmienić skrypt napisany kilka miesięcy lub lat temu. Możliwe, że nie będziesz pamiętać, dlaczego napisałeś skomplikowany fragment kodu, jeśli nie dodasz komentarza.

Komentarze pomagają również innym programistom i administratorom systemu, którzy mogą potrzebować obsługi skryptu, aby zrozumieć kod i jego cel.

Komentarze są zwykle używane do wyjaśnienia tego, czego kod nie może. Na przykład, jeśli masz złożone wyrażenie regularne lub podstawienie parametru w skrypcie Bash, powinieneś napisać komentarz na temat tego, co robi kod. Komentarze powinny być krótkie i na temat. Nie wyjaśniaj czytelnikowi czegoś, co jest proste i oczywiste.

, omówimy podstawy pisania komentarzy w Bash.

Pisanie komentarzy w Bash

Bash ignoruje wszystko, co jest napisane po znaku krzyżyka ( # ) w wierszu. Jedynym wyjątkiem od tej reguły jest to, że pierwsza linia skryptu zaczyna się od #! postacie. Ta sekwencja znaków nazywa się Shebang i służy do informowania systemu operacyjnego, którego interpretera ma użyć do przeanalizowania reszty pliku.

Komentarze można dodawać na początku w wierszu lub w wierszu z innym kodem:

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

Puste miejsce po znaku skrótu nie jest obowiązkowe, ale poprawi czytelność komentarza.

Zazwyczaj po otwarciu skryptu w edytorze tekstu komentarze są reprezentowane na zielono.

Komentarze są również przydatne podczas testowania skryptu. Zamiast usuwać niektóre wiersze lub bloki, możesz je skomentować:

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

Komentarze wielowierszowe w Bash

W przeciwieństwie do większości języków programowania, Bash nie obsługuje komentarzy wielowierszowych.

Najprostszym sposobem pisania komentarzy wieloliniowych w Bash jest dodawanie pojedynczych komentarzy jeden po drugim:

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

Inną opcją jest użycie HereDoc. Jest to rodzaj przekierowania, który pozwala przekazać wiele wierszy danych wejściowych do polecenia. Jeśli blok HereDoc nie zostanie przekierowany do polecenia, może służyć jako symbol zastępczy komentarzy wieloliniowych:

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

Korzystanie z HereDoc to włamanie, a nie wbudowany sposób na pisanie wieloliniowych komentarzy Bash. Aby uniknąć problemów, powinieneś używać komentarzy jednowierszowych.

Wniosek

Pisanie komentarzy jest dobrą praktyką i pomaga innym programistom, w tym przyszłym ja, zrozumieć skrypt powłoki. W Bash wszystko po znaku skrótu ( # ) i do końca linii jest uważane za komentarz.

Jeśli masz jakieś pytania lub uwagi, zostaw komentarz.

terminal bash