Kommentare

Programme werden nicht für jeden Zweck von Grund auf neu geschrieben, sondern Teile von Programmen in unterschiedlichen Zusammenhängen immer wieder verwendet. Damit man selbst noch nach Wochen, Monaten oder Jahren seine eigenen Programme verstehen kann, weiß, wie sie korrekt verwendet werden, und sie an andere Personen weitergeben kann, ist es unbedingt nötig, diese zu dokumentieren.

Man kann eine solche Dokumentation in einer zusätzlichen Datei neben dem Programm speichern. Eine andere Möglichkeit ist, diese Dokumentation in den Programmtext zu integrieren. Dazu biten alle Programmsprachen geeignete Möglichkeiten. Allen gemeinsam ist, dass Kommentare durch vereinbarte Zeichenfolgen gekennzeichnet und diese Kommentare bei der Ausführung eines Programms nicht berücksichtigt werden.

In der Programmsprache LOGO werden Kommentare durch die Zeichenfolge ;* gekennzeichnet. Wenn diese Zeichenfolge in einer Zeile auftaucht, werden diese beiden alle Zeichen bis zum Ende der Programmzeile bei der Ausführung des Programms ignoriert.

Beispiel:

Der mit ;* beginnende Text wird beim Ausführen des Programms ignoriert, ist aber beim Anzeigen der Datei im Editor sichtbar.

Die Programmsprache PYTHON verwendet das #-Zeichen für den Anfang eines Kommentars.

Beispiel:

Darüberhinaus bietet PYTHON weitere Möglichkeiten an, die Dokumentation in die Programmdatei zu integrieren und die integrierte Dokumentation in der Python-Shell sichtbar zu machen. Dieses soll auf der Seite Dokumentation von PYTHON-Programmen erläutert werden.

in unserer programmsprachenunabhängigen Schreibweise verwenden wir die folgenden Notationen: