AA_123rf-13453701_NataliaKlenova_123RF.jpg

© Natalia Klenova, 123RF

Die richtigen Zutaten

Bash-Skripte leserlich programmieren

20.02.2014
Das geniale Skript aus dem letzten Monat enthält nur konfusen Spaghetti-Code, der nicht mehr verrät, was er tut? Mit unseren Tipps aus erprobten Styleguides sorgen Sie für Ordnung und Lesbarkeit.

Bash-Skripte helfen dabei, Dateien umzubenennen, eine große Adressliste zu sortieren oder ähnliche lästige Aufgaben zu erledigen. Die dabei meist unter hohem Zeitdruck geschriebenen Skripte sehen häufig abenteuerlich aus (Listing 1). Schnelle Hacks erfüllen zwar ihren Zweck, sind aber oft unübersichtlich, und die Funktionsweise ist meist eine Woche später komplett unklar. Aus diesem Grund geben viele Anwender die berühmten Einzeiler nicht weiter: Die Empfänger müssten sich erst langwierig einlesen. Schlussendlich ist ein solches kryptisches Skript nur schwer zu erweitern oder zu ändern.

Listing 1

#!/bin/sh
a="100"; b="3"; c="."; d="shot"; for i in `seq 1 $a`; do import -window root $c/$d$i.png; sleep $b; done; exit

Regulator

Aus diesen Gründen sollten Sie Bash-Skripte von Anfang an strukturieren, formatieren und vor allem kommentieren. Dabei helfen Richtlinien, wie sie erfahrene Programmierer in sogenannten Styleguides festgehalten haben. Zwei bekannte Leitfäden stammen von Google [1] und der Fachhochschule Südwestfalen [2]. Ob Sie lieber der privatwirtschaftlichen Anleitung (Abbildung 1) folgen oder der akademischen (Abbildung 2), das bleibt ganz Ihrem Geschmack überlassen; die grundlegenden Richtlinien sind überall gleich.

Abbildung 1: Detaillierte Informationen zu den einzelnen Richtlinien erhalten Sie bei Google, wenn Sie das Dreieck vor einer der Regeln anklicken.
Abbildung 2: Der Styleguide der FH Südwestfalen liegt als PDF vor – und geht nicht nur auf die Formatierung ein.

So sollte Ihr Skript zu Beginn immer die passende Shell nennen. Nutzt es etwa die Funktionen der Bash, schreiben Sie #!/bin/bash in die erste Zeile. Damit funktioniert das Skript auch auf Systemen, die die Bash nicht als Standard-Shell einsetzen, diese aber trotzdem installiert haben.

Frischluftzufuhr

Um das Skript übersichtlicher und leserlicher zu gestalten, sollten Sie den Code immer mit Einrückungen und Leerzeilen versehen. Das schlecht lesbare Listing 1 verwandelt sich auf diese Weise in das schon nicht mehr ganz so kryptische Listing 2.

Listing 2

#!/bin/bash
a="100"
b="3"
c="."
d="shot"
for i in `seq 1 $a`
do
  import -window root $c/$d$i.png;
  sleep $b
done;
exit

Jede Zeile nimmt dabei eine Anweisung auf, eine Leerzeile trennt zusammengehörende Teile des Codes. Letzteres trifft in Listing 2 etwa auf die For-Schleife zu. Die Anweisungen innerhalb eines solchen Blocks sollten Sie jeweils um eine Stufe nach rechts einrücken. Nutzen Sie dazu immer Leerzeichen und keine Tabulatoren: Letztere interpretieren Editoren unterschiedlich. Beinahe unisono empfehlen die Styleguides, jeden Tabulator durch zwei Leerzeichen zu ersetzen.

In Listing 2 steht das do in einer eigenen Zeile. Google empfiehlt, es noch in die Zeile mit dem for zu ziehen. Analoges gilt für eine While-Schleife sowie das then bei einem If-Block. Das else steht jedoch vorzugsweise wieder in einer eigenen Zeile, genauso wie das abschließende done. Apropos If-Anweisung: Google rät, anstelle von test und für dessen Abkürzung mit eckigen Klammern die doppelten Klammern zu verwenden:

if [[ ${dateiname} == "bild*" ]]; then ...

Diese Notation hat den Vorteil, dass sie reguläre Ausdrücke verarbeitet. Zudem reduziert sie Fehler, da die doppelten Klammern weder eigenmächtig Wörter abschneiden noch Dateinamen erweitern.

Diesen Artikel als PDF kaufen

Express-Kauf als PDF

Umfang: 6 Heftseiten

Preis € 0,99
(inkl. 19% MwSt.)

LinuxCommunity kaufen

Einzelne Ausgabe
 
Abonnements
 

Ähnliche Artikel

Kommentare

Infos zur Publikation

LU 06/2015: Shell-Tools

Digitale Ausgabe: Preis € 4,95
(inkl. 19% MwSt.)

Mit der Zeitschrift LinuxUser sind Sie als Power-User, Shell-Guru oder Administrator im kleinen Unternehmen monatlich auf dem aktuelle Stand in Sachen Linux und Open Source.

Sie sind sich nicht sicher, ob die Themen Ihnen liegen? Im Probeabo erhalten Sie drei Ausgaben zum reduzierten Preis. Einzelhefte, Abonnements sowie digitale Ausgaben erwerben Sie ganz einfach in unserem Online-Shop.

NEU: DIGITALE AUSGABEN FÜR TABLET & SMARTPHONE

HINWEIS ZU PAYPAL: Die Zahlung ist auch ohne eigenes Paypal-Konto ganz einfach per Kreditkarte oder Lastschrift möglich!       

Tipp der Woche

Grammatikprüfung in LibreOffice nachrüsten
Grammatikprüfung in LibreOffice nachrüsten
Tim Schürmann, 24.04.2015 19:36, 0 Kommentare

LibreOffice kommt zwar mit einer deutschen Rechtschreibprüfung und einem guten Thesaurus, eine Grammatikprüfung fehlt jedoch. In ältere 32-Bit-Versionen ...

Aktuelle Fragen

Zu wenig Speicherplatz auf /boot unter MATE
Patrick Obenauer, 25.05.2015 14:28, 1 Antworten
Hallo zusammen, ich habe Ubuntu 14.10 mit MATE 1.8.2 (3.16-37) mit Standardeinstellungen aufgese...
Konsole / Terminal in Linux Mint 17.1 deutsch
Dirk Resag, 09.05.2015 23:39, 12 Antworten
Hallo an die Community, ich habe vor kurzem ein älteres Notebook, Amilo A1650G, 1GB Arbeitsspe...
Admin Probleme mit Q4os
Thomas Weiss, 30.03.2015 20:27, 6 Antworten
Hallo Leute, ich habe zwei Fragen zu Q4os. Die Installation auf meinem Dell Latitude D600 verl...
eeepc 1005HA externer sound Ausgang geht nicht
Dieter Drewanz, 18.03.2015 15:00, 1 Antworten
Hallo LC, nach dem Update () funktioniert unter KDE der externe Soundausgang an der Klinkenbuc...
AceCad DigiMemo A 402
Dr. Ulrich Andree, 15.03.2015 17:38, 2 Antworten
Moin zusammen, ich habe mir den elektronischen Notizblock "AceCad DigiMemo A 402" zugelegt und m...