In den weiteren Programmen, die jetzt folgen, wird es häufiger vorkommen, dass der Quellcode dokumentiert ist, genauer gesagt, Kommentare eingefügt sind. Diese Kommentare werden vom Compiler ignoriert. Wie Sie Ihren Quellcode dokumentieren, bleibt letztlich Ihnen selbst überlassen. Sie können beliebig viel, alles oder auch gar nichts dokumentieren.

5.1. Wann sind Kommentare sinnvoll?               

Eigentlich immer. Wenn Sie vorhaben sollten, ein größeres Projekt zu verwirklichen, kann sich dies über mehrere Monate hinausziehen. Um nicht immer wieder das Stückchen Quellcode von neuem verstehen zu müssen, das Sie vor einem Monat geschrieben haben, können Sie sich dies mit ein paar Kommentaren erleichtern. In einer Gruppe ist es ohnehin unerlässlich, mit Kommentaren zu arbeiten, damit jeder den Code des anderen besser versteht und nachvollziehen kann. Hierzu ein Beispiel:

#include <stdio.h>

int main ()       //Beginn des Hauptprogramms
{
   int i = 10;    //Variable int mit dem Namen i und Wert 10
   printf("%d",i);//gibt die Zahl 10 aus
   printf("\n");  //springt eine Zeile weiter
   printf("10");  //gibt den String "10" aus

   return 0;

/*  Hier sehen Sie noch eine 2. Möglichkeit, Kommentare
    einzufügen. Dieser Kommentar wird mit einem Slash-Sternchen
    eröffnet und mit einem Sternchen-Slash wieder beendet.
    Alles dazwischen wird vom Compiler ignoriert  */
}

Kommentare sind nicht schwer zu verstehen. Sie werden einfach beginnend mit zwei // oder zwischen /* Hier steht der Kommentar */ geschrieben. Häufig werden Kommentare vor Funktionen geschrieben. Ein guter Stil könnte so aussehen:

/******************************
 *                            *
 * Beschreibung der Funktion  *
 *                            *
 ******************************/

In den Kommentaren können Sie beliebige Zeichen verwenden, also auch deutsche Umlaute oder das Dollarzeichen.

5.2. Welche Kommentar-Schreibweise: // oder /* */               

Da Sie zwei Möglichkeiten haben, Kommentare zum Programm hinzuzufügen, stellt sich die Frage, welche Methode von den beiden die bessere ist. Die Schreibweise

//Kommentar 

wurde erst im Oktober 1999 zum C99 Standard hinzugefügt. Dieser Stil war zuvor nur für C++ erlaubt und im C89 Standard nicht zugelassen. Problematisch könnte dies werden, wenn Sie einen etwas älteren Compiler verwenden. Er würde einen solchen Kommentar als Fehler bemängeln und sich weigern, das Programm zu übersetzen. Etwas muss außerdem noch beachtet werden, wenn die Schreibweise // verwendet wird, etwa am folgenden Listing:

#include <stdio.h>

int main()
{
   //das Programm befindet sich im Pfad C:\programme\
   printf("Hallo Welt\n");
   return 0;
}

"Hallo Welt" wird niemals ausgegeben. Der Grund dafür ist, dass die Zeile mit dem Kommentar mit einem Backslash endet. Also achten Sie darauf, denn die Suche nach diesem Fehler könnte unnötig Zeit kosten.

Weiter mit Kapitel 6: Formatiertes einlesen mit scanf