Kapitel 4 Kommentare in C
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.
4.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 verstehen und nachvollziehen kann.
Hierzu ein Beispiel:
/* kommentare.c */
#include <stdio.h>
int main (void) { //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 *
* Parameter1 : ... *
* Parameter2 : ... *
* Rückgabewert : ... *
* *
******************************/
In den Kommentaren können Sie beliebige Zeichen verwenden, also auch deutsche Umlaute oder das Dollarzeichen.
|
