Nach der Fertigstellung des Programmes mit der Arduino IDE ist es wichtig den gesamten Code übersichtlich und lesbar darzustellen. Immerhin ist es sehr wahrscheinlich, dass das vorliegende Programm gelesen, verstanden oder weiterentwickelt werden muss. Dabei kann dies auch von einer anderen Person gefordert sein. Der Zeitaufwand einen unkommentierten Code wieder erneut verstehen zu können ist enorm.

Mithilfe der Zeichen "//" werden nachfolgende Befehle in einer Zeile nicht kompiliert und dienen somit nur zur Dokumentation.

int datenpin_sensor = 34; // Datenpin des Sensors

Zu Beginn jedes Programmcodes sollten folgende Informationen vorhanden sein:

  • Autor
  • Erstellungsdatum
  • Ansprechpartner
  • Inhalt
  • Veränderungen

Diese Informationen sollten in einem ganzen Block auskommentiert werden. Am Anfang des Blockes werden die Zeichen "/* gesetzt. Währenddessen stehen am Ende des Blockes die Zeichen "*/".

/*
Autor: Max Mustermann
Erstellungsdatum: 03.10.2020
Ansprechpartner: Stefan Manemann
                 Berufsbildende Schule 2
                 Kleiststraße 44
                 38440 Wolfsburg 
Inhalt: Feuchtigkeitserfassung mit automatischer Bewässerung
Änderungen:        
*/
Zuletzt geändert: Donnerstag, 1. Februar 2024, 11:23