Arduino Code „Richtlinien“

Sauberer, verständlicher und wartbarer Code ist das A und O in der Welt der Programmierung – das gilt auch für Arduino-Projekte. Guter Programmierstil hilft nicht nur dir selbst, den Überblick zu behalten, sondern auch anderen, deinen Code zu verstehen und weiterzuentwickeln. Anhand des klassischen „Blink“-Beispiels zeigen wir dir die wichtigsten Richtlinien für das Schreiben von Arduino-Code. 💡

Die Anatomie eines Arduino-Sketches

Ein Arduino-Programm, auch „Sketch“ genannt, hat eine einfache Grundstruktur, die aus zwei Hauptfunktionen besteht: setup() und loop().

• void setup(): Diese Funktion wird nur einmal beim Start des Arduinos ausgeführt. Hier platzierst du Code, der zur Initialisierung dient, wie z.B. das Definieren von Pin-Modi oder das Starten der seriellen Kommunikation.
• void loop(): Nach dem setup() wird diese Funktion in einer Endlosschleife immer wieder ausgeführt. Hier kommt die eigentliche Logik deines Programms hinein.

Kommentare: Das A und O der Lesbarkeit

Kommentare sind entscheidend, um zu erklären, was dein Code tut, warum er es tut und wie er es tut. Sie werden vom Compiler ignoriert und dienen nur dem menschlichen Verständnis.

Kopfzeilen-Kommentar

Jeder Sketch sollte mit einem Kopfzeilen-Kommentar beginnen, der eine kurze Zusammenfassung des Programms, den Autor und das Datum enthält.

/*
  Blink
  Lässt eine LED für eine Sekunde an- und für eine Sekunde ausgehen, wiederholend.
  Dieses Beispiel ist im Public Domain.
  
  Autor: Dein Name
  Datum: 20. August 2025
*/

/*
  Blink
  Lässt eine LED für eine Sekunde an- und für eine Sekunde ausgehen, wiederholend.
  Dieses Beispiel ist im Public Domain.
  
  Autor: Dein Name
  Datum: 20. August 2025
*/

Zeilen- und Blockkommentare

Nutze Kommentare, um Variablen, Konstanten und komplexere Code-Abschnitte zu erklären.

• // für einzeilige Kommentare.
• /* ... */ für mehrzeilige Kommentare.

Variablen und Konstanten: Aussagekräftige Namen wählen

Die Wahl der Namen für Variablen und Konstanten ist entscheidend für die Lesbarkeit.

Benennung

Verwende aussagekräftige Namen, die den Zweck der Variable beschreiben. Vermeide einbuchstabige oder kryptische Namen wie p oder val. Die gängige Konvention bei Arduino ist camelCase, bei der der erste Buchstabe klein und der Anfang jedes folgenden Wortes großgeschrieben wird.

int p = 13; // "p" ist nicht aussagekräftig

int ledPin = 13; // Beschreibt klar den Zweck

Konstanten verwenden

Wenn sich ein Wert während der Programmausführung nicht ändert, wie z.B. eine Pin-Nummer, deklariere ihn als Konstante mit dem Schlüsselwort const. Das verhindert versehentliche Änderungen im Code und kann dem Compiler helfen, den Code zu optimieren.

// Konstanten am Anfang des Sketches definieren
const int ledPin = 13;
const int blinkInterval = 1000;

// Konstanten am Anfang des Sketches definieren
const int ledPin = 13;
const int blinkInterval = 1000;

Code-Formatierung: Struktur und Konsistenz

Eine konsistente Formatierung macht deinen Code aufgeräumt und leicht zu überblicken.

Einrückungen

Rücke Code innerhalb von geschweiften Klammern {} (z.B. in Funktionen oder Schleifen) konsequent ein. In der Arduino IDE kannst du dies automatisch mit der Tastenkombination Strg + T (oder Cmd + T auf dem Mac) erledigen.

Geschweifte Klammern

Setze die öffnende geschweifte Klammer { bei Funktionen in eine neue Zeile. Bei Kontrollstrukturen wie if oder for kann sie in derselben Zeile stehen. Die schließende Klammer } steht immer in einer eigenen Zeile.

void setup() 
{
  // Pin-Modus setzen
  pinMode(ledPin, OUTPUT);
}

void setup() 
{
  // Pin-Modus setzen
  pinMode(ledPin, OUTPUT);
}

Das „Blink“-Beispiel mit gutem Stil

Hier ist der vollständige „Blink“-Sketch, der die oben genannten Richtlinien befolgt.

/*
  Blink - Guter Programmierstil

  Lässt die eingebaute LED (oder eine an Pin 13 angeschlossene) 
  im Sekundentakt blinken. Dieses Beispiel demonstriert grundlegende 
  Code-Richtlinien für Arduino.

  Autor: Dein Name
  Datum: 20. August 2025
*/

// Konstanten für Pin-Nummern und Zeitintervalle verwenden
const int ledPin = LED_BUILTIN; // LED_BUILTIN ist eine Konstante für den On-Board-LED-Pin
const int blinkInterval = 1000; // Das Intervall für das Blinken in Millisekunden

// Diese Funktion wird einmal beim Start des Boards ausgeführt
void setup() 
{
  // Den digitalen Pin als Ausgang initialisieren.
  pinMode(ledPin, OUTPUT);
}

// Die loop-Funktion wird nach dem Setup unendlich oft wiederholt
void loop() 
{
  digitalWrite(ledPin, HIGH);   // Die LED einschalten (HIGH = Spannungslevel ist an)
  delay(blinkInterval);         // Eine Sekunde warten
  digitalWrite(ledPin, LOW);    // Die LED ausschalten (LOW = Spannungslevel ist aus)
  delay(blinkInterval);         // Eine Sekunde warten
}

/*
  Blink - Guter Programmierstil

  Lässt die eingebaute LED (oder eine an Pin 13 angeschlossene) 
  im Sekundentakt blinken. Dieses Beispiel demonstriert grundlegende 
  Code-Richtlinien für Arduino.

  Autor: Dein Name
  Datum: 20. August 2025
*/

// Konstanten für Pin-Nummern und Zeitintervalle verwenden
const int ledPin = LED_BUILTIN; // LED_BUILTIN ist eine Konstante für den On-Board-LED-Pin
const int blinkInterval = 1000; // Das Intervall für das Blinken in Millisekunden

// Diese Funktion wird einmal beim Start des Boards ausgeführt
void setup() 
{
  // Den digitalen Pin als Ausgang initialisieren.
  pinMode(ledPin, OUTPUT);
}

// Die loop-Funktion wird nach dem Setup unendlich oft wiederholt
void loop() 
{
  digitalWrite(ledPin, HIGH);   // Die LED einschalten (HIGH = Spannungslevel ist an)
  delay(blinkInterval);         // Eine Sekunde warten
  digitalWrite(ledPin, LOW);    // Die LED ausschalten (LOW = Spannungslevel ist aus)
  delay(blinkInterval);         // Eine Sekunde warten
}

Indem du diese einfachen Richtlinien befolgst, werden deine Arduino-Sketches nicht nur für dich, sondern auch für die gesamte Community verständlicher und besser nutzbar. Viel Spaß beim Codieren!