Kommentare in C++

von: Ansgar Schiffler

zurück zu 'Die Programmiersprache C++'

 

Damit es Ihnen später leichter fällt, Ihre eigenen Programme zu verstehen, ist es sinnvoll Kommentare zu schreiben. Dies hilft auch anderen Personen, Ihren Quellcode zu verstehen. Kommentare werden vom Compiler ignoriert.

Sie haben zwei Möglichkeiten, Kommentare kenntlich zu machen.

1. '//': alles was in der gleichen Zeile dahinter folgt, wird als Kommentar gewertet.

2. /*      */: alles was zwischen diesen beiden Zeichen steht, wird als Kommentar angesehen.

Die zweite Variante bietet sich dann an, wenn Sie Kommentare schreiben möchten, die über mehrere Zeilen gehen.

Ein Beispiel:

#include <iostream.h>
#include <stdio.h>

int main() //Autor: Max Mustermann, 04.10.05, BBS Bingen
{
/*
Der Benutzer gibt zwei Zahlen ein, diese Zahlen werden
addiert und das Ergebnis wird ausgegeben.
*/

float zahl1, zahl2, ergebnis;      //Variablen deklarieren

cout<<"\nGeben Sie die erste Zahl ein: ";
cin>>zahl1;                           //Erste Zahl einlesen

cout<<"\nGeben Sie die zweite Zahl ein: ";
cin>>zahl2;                          //Zweite Zahl einlesen


ergebnis = zahl1 + zahl2;       //Zahlen addieren

cout<<"\n"<<zahl1 <<" + "<<zahl2 <<" = "<<ergebnis;

if (ergebnis >= 0)
     {
     cout<<"\nDas Ergebnis ist positiv!";
      }//if (ergebnis >= 0)
else
     {
      cout<<"\nDas Ergebnis ist nicht positiv!";
     }//else

getchar();
return 0;
}// end of int main()

Es gibt keine feste Regel dafür, wie viele Kommentare sie schreiben sollten. Zu viele Kommentare können auch den Blick auf das Wesentliche erschweren.  Hier hätte auch gut darauf verzichtet werden können, hinter der schließenden geschweiften Klammer noch einmal die Bedingung zu wiederholen, zu der diese schließende Klammer gehört: ' }//if (ergebnis >= 0)'.

Bei vielen ineinander verschachtelten Verzweigungen kann dies jedoch sinnvoll sein, um den Überblick zu behalten.

zurück zu 'Die Programmiersprache C++'