Beim Erstellen von Bash-Skripten ist es wichtig, deinen Code übersichtlich und verständlich zu gestalten. Dazu gehört das Strukturieren des Codes in Blöcken, Einrücken sowie das Benennen von Variablen und Funktionen.
Eine zusätzliche Methode, um die Lesbarkeit deines Codes zu erhöhen, ist die Nutzung von Kommentaren. Kommentare sind menschenlesbare Erläuterungen oder Hinweise, die direkt im Shell-Skript verfasst werden.
Kommentare in deinen Bash-Skripten zu verwenden, spart dir zukünftig Zeit und Aufwand, wenn du deinen Code erneut betrachtest. Angenommen, du möchtest ein Skript anpassen, das du vor Monaten oder Jahren verfasst hast. Ohne Kommentare wirst du wahrscheinlich nicht mehr wissen, warum du einen bestimmten komplexen Codeabschnitt erstellt hast.
Außerdem helfen Kommentare anderen Entwicklerinnen und Entwicklern sowie Systemadministratorinnen und Systemadministratoren, die das Skript eventuell betreuen müssen, deinen Code und dessen Zweck zu begreifen.
Kommentare dienen der Erläuterung des Codes. Wenn du beispielsweise eine komplexe Regex oder eine Parametersubstitution in deinem Bash-Skript verwendest, sollte ein Kommentar hinzugefügt werden, der beschreibt, welche Funktion der Code hat. Kommentare sollten präzise und knapp sein. Offensichtliche Informationen müssen nicht erklärt werden.
In diesem Beitrag behandeln wir die Grundlagen zum Verfassen von Kommentaren in Bash.
Kommentare in Bash verfassen
Bash ignoriert sämtlichen Text, der in einer Zeile nach dem Rautensymbol (#) steht. Die einzige Ausnahme von dieser Regel ist, wenn die erste Skriptzeile mit #! beginnt. Diese Zeichenkombination wird als Shebang bezeichnet und teilt dem Betriebssystem mit, welchen Interpreter es zum Analysieren der restlichen Datei verwenden soll.
Kommentare können am Anfang einer Zeile oder in derselben Zeile wie der Code platziert werden:
# Das ist ein Bash-Kommentar.
echo "Das ist Code" # Das ist ein Inline-Bash-Kommentar.
Das Leerzeichen nach dem Rautensymbol ist nicht obligatorisch, erhöht aber die Lesbarkeit des Kommentars.
Falls dein Texteditor Syntax-Hervorhebung unterstützt, werden Kommentare normalerweise in Grün angezeigt.
Kommentare sind auch beim Testen eines Skripts hilfreich. Anstelle von Zeilen oder Blöcken zu löschen, kannst du sie auskommentieren:
# if [[ $VAR -gt 10 ]]; then
# echo "Variable ist größer als 10."
# fi
Mehrzeilige Kommentare in Bash
Anders als bei vielen anderen Programmiersprachen, unterstützt Bash keine mehrzeiligen Kommentare.
Die einfachste Möglichkeit, mehrzeilige Kommentare in Bash zu erstellen, besteht darin, aufeinanderfolgende Einzelkommentare einzufügen:
# Dies ist Zeile eins.
# Dies ist Zeile zwei.
Ein weiterer Ansatz ist die Verwendung von HereDoc. Das ist eine Art der Umleitung, die es ermöglicht, mehrere Eingabezeilen an einen Befehl zu übergeben. Wird der HereDoc-Block nicht an einen Befehl weitergeleitet, kann er als Ersatz für mehrzeilige Kommentare dienen:
: 'MEHRZEILIGER-KOMMENTAR'
Alles innerhalb des
HereDoc-Blocks ist
ein mehrzeiliger Kommentar
MEHRZEILIGER-KOMMENTAR
Die Nutzung von HereDoc ist eher ein Trick als eine echte eingebaute Funktion zum Erstellen mehrzeiliger Bash-Kommentare. Um Probleme zu vermeiden, solltest du vorzugsweise einzeilige Kommentare verwenden.
Fazit
Kommentare zu verfassen ist eine sinnvolle Vorgehensweise und unterstützt andere Entwicklerinnen und Entwickler, auch dich selbst, dabei, das Shell-Skript zu durchschauen. In Bash gelten alle Texte, die nach dem Rautensymbol (#) und bis zum Zeilenende stehen, als Kommentar.
Wenn du Fragen oder Anregungen hast, kannst du gerne einen Kommentar hinterlassen.