Kommentare

In C werden Kommentare mit '/*' eingeleitet und enden mit '*/'.

Bsp:

  int main(/* BLA BLA */void)
  {
    /*Sinnloser
      Kommentar */
  }

Achtung, Kommentare können nicht wie Klammern geschachtelt werden! Das bedeutet, wenn ihr einen Codeteil auskommentieren wollt, in dem bereits solche Kommentare vorhanden sind, wird das nicht funktionieren. Ein Beispiel:

  int main(/* BLA BLA */void)
  {
    printf( "Erster Text\n" );
 
  /* Auskommentiert, weil der Code Sinnlos ist.
    /*Sinnloser
      Kommentar */
    printf( "Überflüssiger Text\n" );
  */
  }

Wie ihr vielleicht bereits am Syntax Highlighting erkennt, geht der Kommentar nur bis zum ersten „*/“. Das bedeutet der Codeteil und der Asteriks (*) und der Slash (/) bleiben als Operatoren im Code enthalten. Syntaktisch ist der Code nun falsch und erzeugt einen Compilerfehler.

C++-Kommentare

In C++ gibt es weiters die Möglichkeit Zeilenkommentare einzufügen, die mit "//" eingeleitet werden. Alles was nach diesen zwei Zeichen kommt wird ignoriert.

  int main(/* BLA BLA */void)
  {
    /* // vollkommen
      Sinnloser
      Kommentar */
 
    // Auch sinnlos.
  }

Manche C Compiler akzeptieren auch C++ Kommentare. C++-Kommentare allerdings in C Programmen zu verwenden gehört zum „schlechten Stil“ und sollte vermieden werden.

Auskommentieren für Fortgeschrittene

Wie kommentiere ich richtig?

Es gibt wohl kein Programm das zu viel kommentiert wurde, aber eine Menge, die deutlich zu wenig kommentiert wurden. Erkläre Dein Programme in Ihren kurzen Sätzen, ruhig abschnittsweise, aber kommentiere!

int main( void )
{
  /* Vorbereitungen */
 
  ...
 
  /* Benutzer abfragen */
 
  ...
 
  /* Berechnen 
  **
  ** Die Berechnung macht dies und jenes
  */
 
  ...
 
  /* Durch den folgenden Trick <-Erklärung-> berechne ich diesen Teil */
 
  ...
 
  /* Werte ausgeben */
 
  ...
 
  return EXIT_SUCCESS;
}

Nur so wirst Du Deinen Quelltext Monate später wieder schnell verstehen können. Vermeide dabei aber Kommentare, die direkt aus dem Quelltext ersichtlich sind, etwa so:

  /* "Hallo Welt" auf den Bildschirm schreiben */
 
  printf( "Hallo Welt\n" );  

Das ist sinnlos und führt dazu, dass man die Kommentare nicht mehr liest.

Häufig wird man sich beim Kommentieren klarer darüber, was und wie man eigentlich programmiert hat und ob das wirklich das ist, was man programmieren wollte. Daher gehen manche Programmierer auch den anderen Weg und beschreiben erst, was sie tun wollen, bevor sie zwischen den Kommentaren das Programm einfügen.

Wichtig ist: Die Qualität der Programme wird also mit den Kommentaren gesteigert.