Mail to Code: Tutorial

Lernt, wie man den Code für Rechenknechte schreibt.

English version English Version

Kommentare

Im Quellcode eines Programms können an beliebiger Stelle Kommentare verfasst werden. Auch wenn im Prinzip gilt:
Ein gut geschriebener Quellcode ist selbsterklärend.
so ist es in der Praxis so, dass mit dem Umfang eines Programms doch der ein oder andere Codeblock einer genaueren Erklärung bedarf, um somit das Verstehen der Logik hinter den Programmzeilen zu vereinfachen. Wie alles in einem Computerprogramm, müssen auch Kommentare bestimmten Regeln folgen:

Einzeilige Kommentare

Im Kapitel zur Grundstruktur eines Programms haben wir bereits zwei Zeilen gesehen, die nicht zum ausführbaren Teil gehören, sondern lediglich Kommentare darstellen. Sämtlicher Text in einer Zeile, der sich hinter einem doppelten Schrägstrich (English: Slash) befindet, wird von dem Kompiler verworfen.

1
2
3
4
5
6
7
8
9
void setup() {
  // put your setup code here, to run once:
 
}
 
void loop() {
  // put your main code here, to run repeatedly:
 
}
    

Befehle "auskommentieren"

Beim Testen eines Programms kommt es häufiger vor, dass man einen Befehl in einer Programmzeile deaktivieren möchte. Ebenfalls hilfreich kann es sein, zwei unterschiedliche Befehle als Option für einen Quellcode anzubieten. Um das zu erreichen, kann man den doppelten Schrägstrich "//" einfach an den Anfang der entsprechenden Zeile schreiben, womit diese beim Kompillieren ignoriert wird:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
void setup() {
  // put your setup code here, to run once:
 
  pinMode(4, OUTPUT);  // GPIO 4 is output
  pinMode(5, OUTPUT);  // GPIO 5 is output
 
  digitalWrite(4, HIGH); // Turn on LED 4 on startup
 
  // If you'd like to have LED 5 turned on at startup, uncomment the following line
  //digitalWrite(5, HIGH); // Turn on LED 5 on startup
}
 
void loop() {
  // put your main code here, to run repeatedly:
 
}
    

Belässt man den Quellcode wie hier abgebildet, so leuchtet nur die an GPIO Nummer 4 angeschlossene LED, sobald der Mikrocontroller eingeschaltet wird.
Entfernt man allerdings den doppelten Schrägstrich am Anfang von Zeile 10, so leuchten die LEDs an GPIO Nummer 4 und Nummer 5.
Wird anschließend ein doppelter Schrägstrich an den Anfang von Zeile 7 gesetzt, so leuchtet nur LED Nummer 5
In Zeile Nummer 10 wird nach dem Entfernen des doppelten Schrägstrichs am Zeilenanfang, der Text hinter dem zweiten, doppelten Schrägstrich vom Kompiller weiterhin ignoriert. Hier handelt es sich ja um einen Kommentar, der lediglich für Menschen gedacht ist und für den Kompiler keinen Sinn ergibt.

Mehrzeilige Kommentare

Bisweilen reicht eine einzelne Zeile nicht, um einen Sachverhalt für Menschen ausreichend zu beschreiben. Selbstverständlich kann man mehrere Zeilen schreiben und an jeden Zeilenanfang einen doppelten Schrägstrich schreiben, aber das ist doch etwas umständlich. Einfacher geht es, wenn man einen ganzen Block als Kommentar kennzeichnet. Das geschieht durch die einleitende Zeichenkombination "/*", Alle Zeichen nach dieser Markierung werden vom Kompiller ignoriert. Um den Kommentar zu beenden, muss die Zeichenkombination in umgekehrter Reihenfolge als "*/" geschrieben werden. Nach dieser abschließenden Markierung wird der folgende Text wieder als Quelltext betrachtet und in Maschinensprache übersetzt.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
void setup() {
  /* If you need a longer text block to explain what is going on in
  your source code, you can do that in a multi line comment.
  For exapmle:
  this is the setup loop that runs once after startup or whenever
  the reset button is pressed.
 
  This multi line comment ends here. */
 
  // This is a one line comment
 
 
  pinMode(4, OUTPUT);  // GPIO 4 is output
  pinMode(5, OUTPUT);  // GPIO 5 is output
 
  // You can also use the multi line comment markings to deactivate
  // multiple lines of code. The following two lines are deactivated:
 
  /*
  digitalWrite(4, HIGH); // Turn on LED 4 on startup
  digitalWrite(5, HIGH); // Turn on LED 5 on startup
  */
}
 
void loop() {
  // put your main code here, to run repeatedly:
 
}
    

In diesem Beispiel sind die beiden Zeilen 20 und 21 auskommentiert, also deaktiviert und werden vom Kompiller ignoriert. Keine der an den GPIOs Nummer 4 und 5 angeschlossenen LEDs leuchtet beim Programmstart.

<<< Grundstruktur
Inhaltsverzeichnis
GPIO als digitaler Ausgang >>>


Du findest diese Seite klasse?

Gummibärchen als Nervennahrung beim Programmieren und der Betrieb dieses Servers verschlingen mein Geld.
Helft mit einer Motivationsspritze, dieses Projekt am Laufen zu halten.

Klick hier oder scan den QR Code, um eine Spende zu überweisen.



Vielen Dank!

Fragen? Anregungen? Fehler gefunden?
Kontakt per E-mail: question@h1i1.de