Kommentare in Bash-Skripten schreiben

Beim Schreiben von Bash-Skripten empfiehlt es sich immer, den Code sauber und leicht verständlich zu gestalten. Dazu können Sie den Code in Blöcken organisieren, Einrückungen vornehmen, Variablen und Funktionen beschreibende Namen geben.

Eine andere Möglichkeit, die Lesbarkeit Ihres Codes zu verbessern, besteht in der Verwendung von Kommentaren. Ein Kommentar ist eine für Menschen lesbare Erklärung oder Anmerkung, die im Shell-Skript geschrieben ist.

Das Hinzufügen von Kommentaren zu Ihren Bash-Skripten erspart Ihnen viel Zeit und Mühe, wenn Sie sich in Zukunft Ihren Code ansehen. Angenommen, Sie möchten ein Skript ändern, das Sie vor einigen Monaten oder Jahren geschrieben haben. Möglicherweise werden Sie sich nicht erinnern, warum Sie einen komplizierten Code geschrieben haben, es sei denn, Sie haben einen Kommentar hinzugefügt.

Die Kommentare helfen auch anderen Entwicklern und Systemadministratoren, die das Skript möglicherweise warten müssen, um Ihren Code und seinen Zweck zu verstehen.

Kommentare werden normalerweise verwendet, um zu erklären, was der Code nicht kann. Wenn Sie beispielsweise eine komplexe Regex- oder Parameterersetzung in Ihrem Bash-Skript haben, sollten Sie einen Kommentar zur Funktionsweise des Codes schreiben. Kommentare sollten kurz und sachlich sein. Erklären Sie nichts, was für den Leser einfach und offensichtlich ist.

Wir werden die Grundlagen des Schreibens von Kommentaren in Bash behandeln.

Kommentare in Bash schreiben

Bash ignoriert alles, was nach der Raute ( # ) in der Zeile steht. Die einzige Ausnahme von dieser Regel ist, wenn die erste Zeile im Skript mit dem #! beginnt #! Zeichen. Diese Zeichenfolge heißt Shebang und teilt dem Betriebssystem mit, mit welchem ​​Interpreter der Rest der Datei analysiert werden soll.

Kommentare können am Anfang der Zeile oder inline mit anderem Code eingefügt werden:

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

Das Leerzeichen nach der Raute ist nicht obligatorisch, verbessert jedoch die Lesbarkeit des Kommentars.

Wenn das Skript in einem Texteditor geöffnet wird, werden Kommentare normalerweise grün dargestellt.

Kommentare sind auch beim Testen eines Skripts hilfreich. Anstatt einige Zeilen oder Blöcke zu löschen, können Sie sie auskommentieren:

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

Mehrzeilige Kommentare in Bash

Im Gegensatz zu den meisten Programmiersprachen unterstützt Bash keine mehrzeiligen Kommentare.

Die einfachste Möglichkeit, mehrzeilige Kommentare in Bash zu schreiben, besteht darin, einzelne Kommentare nacheinander hinzuzufügen:

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

Eine andere Option ist HereDoc. Es handelt sich um eine Umleitungsart, mit der Sie einem Befehl mehrere Eingabezeilen übergeben können. Wenn der HereDoc-Block nicht an einen Befehl umgeleitet wird, kann er als Platzhalter für mehrzeilige Kommentare dienen:

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

HereDoc zu verwenden ist ein Hack, keine echte Methode, um mehrzeilige Bash-Kommentare zu schreiben. Um Probleme zu vermeiden, sollten Sie lieber einzeilige Kommentare verwenden.

Fazit

Das Schreiben von Kommentaren ist eine gute Vorgehensweise und hilft anderen Entwicklern, einschließlich des zukünftigen Selbst, das Shell-Skript zu verstehen. In Bash wird alles nach der Raute ( # ) und bis zum Ende der Zeile als Kommentar betrachtet.

Wenn Sie Fragen oder Feedback haben, können Sie gerne einen Kommentar hinterlassen.

Bash-Terminal