Programm kommentieren

Hinweis: Dieser Schritt ist nur zu bearbeiten, wenn das Programm mit "Arduino IDE" erstellt wurde

Einer der wichtigsten Aufgaben bei der Programmierung ist die Kommentierung des Codes. Kommentare stellen sicher, dass alle Teammitglieder Ihren Code verstehen können und mögliche Änderungen vorgenommen werden können.

Durch die Zeichen "//" werden alle nachfolgenden Zeichen nicht kompiliert und sind somit nur sichtbar. Kommentare dienen also nicht zur Funktion des Codes, sondern um Beschreibungen und Erklärungen einzufügen. Dabei gilt: Umso mehr kommentiert wurde, desto besser.

Am Anfang jedes Quellendes sind die Autoren, Ansprechpartner mit Kontaktangaben, Erstellungsdatum und eine Beschreibung der Funktion des Codes aufgeführt. Wenn mehrere Personen am gleichen Code arbeiten, sollten Änderungen ebenfalls als Kommentar eingefügt werden. Dabei soll beschreiben, wer wann und was geändert hat. Um ganze Blöcke auskommentieren zu können, werden die Zeichen "/*" am Anfang des Blocks und "*/" am Ende des Blockes eingefügt.

Vervollständigen Sie nun Ihren Code mit Kommentaren.

Tipp: Um einen Programmiercode übersichtlich darzustellen, kann zum Beispiel mit einem online Tool zur Hervorhebung der Syntax gearbeitet werden: https://pinetools.com/syntax-highlighter