AA_123rf-13453701_NataliaKlenova_123RF.jpg

© Natalia Klenova, 123RF

Bash-Skripte leserlich programmieren

Die richtigen Zutaten

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
 
TABLET & SMARTPHONE APPS
Bald erhältlich
Get it on Google Play

Deutschland

Ähnliche Artikel

  • Einführung in die Bash-Programmierung
    Skripte sollen meist wiederkehrende oder lästige Arbeiten automatisieren. Die Standard-Shell Bash stellt Ihnen dazu eine ganze Reige von Funktionen bereit. Dieser Artikel erklärt, wie Sie ihre eigenen Shell-Skripte schreiben.
  • Ohne Crash durch die Bash
    Mit der Bourne-Again-Shell schreiben Linux-Anwender Skripte, die nervige und stupide Aufgaben automatisieren – etwa um auf dem Notebook Strom einzusparen.
  • Bash-Skripte prüfen lassen
  • Doppeltes Lottchen
    Batsh schlägt zwei Fliegen mit einer Klappe: In dieser Sprache geschriebene Programme lassen sich sowohl in Bash-Skripte als auch in die unter Windows genutzten Batch-Dateien übersetzen.
  • Mit SHC Bash-Skripte kompilieren
    Der Shell Script Compiler wandelt Skripte in Binärprogramme um. Das schützt vor unbeabsichtigten Veränderungen, birgt aber auch einige Tücken.
Kommentare

Infos zur Publikation

LU 12/2016: Neue Desktops

Digitale Ausgabe: Preis € 5,99
(inkl. 19% MwSt.)

LinuxUser erscheint monatlich und kostet 5,95 Euro (mit DVD 8,50 Euro). Weitere Infos zum Heft finden Sie auf der Homepage.

Das Jahresabo kostet ab 86,70 Euro. Details dazu finden Sie im Computec-Shop. Im Probeabo erhalten Sie zudem drei Ausgaben zum reduzierten Preis.

Bei Google Play finden Sie digitale Ausgaben für Tablet & Smartphone.

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

Aktuelle Fragen

Brother Drucker DCP-J4120
Achim Zerrer, 09.12.2016 18:08, 0 Antworten
Hallo, ich wollte unter Leap 42.1 den Brother Drucker installieren und dazu das PPD- Datei vom do...
Drucker Epson XP-332 unter ubuntu 14.04 einrichten
Andrea Wagenblast, 30.11.2016 22:07, 2 Antworten
Hallo, habe vergeblich versucht mein Multifunktionsgerät Epson XP-332 als neuen Drucker unter...
Apricity Gnome unter Win 10 via VirtualBox
André Driesel, 30.11.2016 06:28, 2 Antworten
Halo Leute, ich versuche hier schon seit mehreren Tagen Apricity OS Gnome via VirtualBox zum l...
EYE of Gnome
FRank Schubert, 15.11.2016 20:06, 2 Antworten
Hallo, EOG öffnet Fotos nur in der Größenordnung 4000 × 3000 Pixel. Größere Fotos werden nic...
Kamera mit Notebook koppeln
Karl Spiegel, 12.11.2016 15:02, 2 Antworten
Hi, Fotografen ich werde eine SONY alpha 77ii bekommen, und möchte die LifeView-Möglichkeit nu...