Beim Schreiben von Bash-Skripten ist es immer eine gute Praxis, Ihren Code sauber und leicht verständlich zu machen. Das Organisieren Ihres Codes in Blöcken, Einrücken, Vergeben von beschreibenden Namen für Variablen und Funktionen sind mehrere Möglichkeiten, dies zu tun.
Eine weitere Möglichkeit, die Lesbarkeit Ihres Codes zu verbessern, ist die Verwendung von Kommentaren. Ein Kommentar ist eine für Menschen lesbare Erklärung oder Anmerkung, die in das Shell-Skript geschrieben wird.
Das Hinzufügen von Kommentaren zu Ihren Bash-Skripten wird Ihnen viel Zeit und Mühe ersparen, wenn Sie sich Ihren Code in Zukunft ansehen. Angenommen, Sie möchten ein Skript ändern, das Sie vor einigen Monaten oder Jahren geschrieben haben. Die Chancen stehen gut, dass Sie sich nicht erinnern werden, warum Sie ein kompliziertes Stück 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 verwendet, um den Code zu erklären. Wenn Sie beispielsweise eine komplexe Regex- oder Parameterersetzung in Ihrem Bash-Skript haben, sollten Sie einen Kommentar schreiben, der beschreibt, was der Code tut. Kommentare sollten kurz und prägnant sein. Erklären Sie nichts, was für den Leser einfach und offensichtlich ist.
In diesem Artikel behandeln wir die Grundlagen zum Schreiben von Kommentaren in Bash.
Schreiben von Kommentaren in Bash #
Bash ignoriert alles, was in der Zeile nach dem Doppelkreuz steht (# ). Die einzige Ausnahme von dieser Regel ist, wenn die erste Zeile des Skripts mit #! beginnt Figuren. Diese Zeichenfolge wird Shebang genannt und wird verwendet, um dem Betriebssystem mitzuteilen, welcher Interpreter verwendet werden soll, um den Rest der Datei zu analysieren.
Kommentare können am Anfang der Zeile oder inline mit anderem Code hinzugefügt werden:
# This is a Bash comment.
echo "This is Code" # This is an inline Bash comment.
Das Leerzeichen nach dem Hash-Zeichen ist nicht obligatorisch, verbessert aber die Lesbarkeit des Kommentars.
Wenn Ihr Texteditor Syntaxhervorhebung unterstützt, werden Kommentare normalerweise grün dargestellt.
Kommentare sind auch beim Testen eines Skripts nützlich. Anstatt einige Zeilen oder Blöcke zu löschen, können Sie sie auskommentieren:
# if [[ $VAR -gt 10 ]]; then
# echo "Variable is greater than 10."
# fi
Mehrzeilige Kommentare in Bash #
Anders als die meisten Programmiersprachen unterstützt Bash keine mehrzeiligen Kommentare.
Der einfachste Weg, mehrzeilige Kommentare in Bash zu schreiben, besteht darin, einzelne Kommentare nacheinander hinzuzufügen:
# This is the first line.
# This is the second line.
Eine weitere Möglichkeit ist die Verwendung von HereDoc. Es handelt sich um eine Art Umleitung, mit der Sie mehrere Eingabezeilen an einen Befehl übergeben können. Wenn der HereDoc-Block nicht auf 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
Die Verwendung von HereDoc ist ein Hack, keine wirklich eingebaute Möglichkeit, mehrzeilige Bash-Kommentare zu schreiben. Um Probleme zu vermeiden, sollten Sie einzeilige Kommentare bevorzugen.
Schlussfolgerung #
Das Schreiben von Kommentaren ist eine gute Übung und hilft anderen Entwicklern, einschließlich zukünftigen Entwicklern, das Shell-Skript zu verstehen. In Bash ist alles nach dem Hash-Zeichen (# ) und bis zum Ende der Zeile gilt als Kommentar.
Wenn Sie Fragen oder Feedback haben, können Sie gerne einen Kommentar hinterlassen.