Programmiersprache Pascal

Kommentare

Programme sollten ausreichend kommentiert werden.
Zum Beispiel sollten Kommentare Auskunft geben über

den Verwendungszweck von Programmeinheiten,
die Schnittstellen von Programmeinheiten (Aufrufparameter: Anzahl, Typ, Restriktionen),
kritische Operationen (z.B. systemabhängige Lösungen),
den Programmautor (Programmierer oder Firma) und seine Erreichbarkeit (z.B. E-Mail-Adresse),
Nachnutzungsbedingungen.

Oft wird - zu Recht - empfohlen, erst den Kommentar zu schreiben, und dann den zugehörigen Programmcode.
Diese Vorgehensweise bietet folgende Vorteile:

Im weiteren Prozeß der Entwicklung werden Kommentare wegen "anderer wichtiger Probleme" oft nicht mehr geschrieben.
Der Programmierer wird dazu gezwungen, vor Beginn der Codierung nachzudenken, was er erreichen will.
(Dies sollte zwar selbstverständlich sein, aber die Praxis läßt mitunter den Verdacht aufkommen ...)

Die Umkehrung dieser Vorgehensweise läßt sich im englischen sehr prägnant ausdrücken:

Code now, think later !

Kommentare sollten jedoch einen bestimmten Umfang nicht überschreiten, da sonst die Programmlesbarkeit leidet.
Es sollte Klarheit bestehen, für wen Kommentare geschrieben werden.
Dinge, die ein "normaler" Programmierer ohne weiteres aus dem Quelltext herauslesen kann, müssen nicht im Kommentar erläutert werden.

Kommentare werden in Pascal in geschweifte Klammern eingeschlossen. Der eingeschlossene Kommentar darf sich über mehrere Zeilen erstrecken:

  {
    Kommentar
  }

Da nicht alle Rechner die Zeichen { } unterstütz(t)en, ist eine alternative Notation möglich:

  (*  Kommentar  *)

Die Pascal Standards lassen eine Mischung beider Varianten zu:

Das erste } nach einem (* und
das erste *) nach einem {

beenden einen Kommentar.

Kommentare werden vom Compiler überlesen und sind für den erzeugten Programmcode ohne Bedeutung. Kommentare sind "lediglich" für die Leser des Quelltextes wichtig.

Achtung:
In einigen Programmiersystemen kann die Arbeit des Compilers durch Optionen gesteuert werden, die syntaktisch in der Gestalt von Kommentaren notiert werden. Derartige "Kommentare" werden mitunter auch als Pragmas bezeichnet und können sehr wohl Einfluß auf den erzeugten Programmcode nehmen.

Die Ineinanderschachtelung von Kommentaren kann zu syntaktischen Problemen führen:
Nach Einleitung eines Kommentars werden alle Zeichen bis zum nächsten Kommentarendezeichen ignoriert.
Eventuell kann eine begrenzte Schachtelung durch die kombinierte Nutzung der Klammerpaare { } und (* *) gelingen, falls der Übersetzer in Abhängigkeit vom Kommentaranfangszeichen verschiedene Kommentararten unterscheidet.

Achtung:
Nach den Regeln der Pascal Standards ist eine Schachtelung eindeutig ausgeschlossen.
Manche Pascal-Systeme erlauben aber (in Abhängigkeit von Compiler-Optionen) geschachtelte Kommentare.

Turbo Pascal, Delphi

Einige mit {$ beginnende Kommentarzeilen haben eine spezielle Bedeutung: Sie steuern die Arbeit des Compilers.
Beispiel: {$N+} numerischen Koprozessor nutzen

Pascal++

Mit {$ beginnende Kommentarzeilen werden als implementationsabhängige Pragmas gewertet. Pragmas nehmen Einfluß auf die Arbeit des Programmiersystems.

P. Böhme, 07.09.1996