Kommentare im Quellcode

Im Musterprogramm auf der vorletzten Seite wurde ein zweckmäßiges Maß an Kommentaren gewählt. Kommentare sollen Ihr Programm verständlicher machen. Kommentare richten sich an Fachleute, die der C-Programmierung mächtig sind, aber Ihr Programm nicht kennen. Der Leser soll möglichst schnell den Quellcode verstehen können. Ein Programm kann zu wenige, aber auch zu viele Kommentare enthalten. Auf dieser Seite finden Sie ein paar Anhaltspunkte zum guten Kommentieren Ihres Quellcodes.

Inhalt der Kommentare

• Kommentare sollten in kurzer Form die wichtigsten Informationen enthalten.
• Offensichtliche Informationen sollten nicht wiederholt werden. Beispiel:
  int index; /* Indexvariable */

Was sollte kommentiert werden?

• Alle Quellcode-Dateien solten zu Beginn einen Hinweis mit Dateinamen, Autor, Datum, Version und Beschreibung erhalten
• Alle Definitionen von Variablen (hinter die Definition)
• Logische Blöcke im Programmablauf (extra Zeile oberhalb des Blockes)
• Funktionsdefinitionen (extra Zeile oder dahinter)
• Besonderheiten bei einzelnen Programmzeilen (hinter die Programmzeile)

Was sollte nicht kommentiert werden?

• Jede Programmzeile
• Offensichtliche Dinge wie /* hier beginnt das Hauptprogramm */ oder /* Definition der Variablen */
• Wiederholung der Variablennamen, z.B. int counter; /* counter */