Sonderkapitel: Kommentare

8.1 Arten:
8.1.1 {...} als Kommentar
Es gibt zwei Arten von Kommentaren. Meistens werden die geschweiften Klammern {...} bevorzugt. Alles, was zwischen ihnen steht, wird vom Compiler missachtet und nicht mit übersetzt. Sie können an jeder beliebigen Stelle im Programm stehen, solange sie kein wichtiges Wort unterbrechen. Ein Beispiel:

PROCEDURE bis_zur_wand;    { geht solange nach vorne, bis er an eine Wand kommt }
BEGIN
 WHILE vorne_frei DO vor;
END;


Der Kommentar ist hier direkt hinter dem Prozedurnamen. Weiteres dazu lesen Sie dann im Sonderkapitel 9: Stil. Dort finden Sie den Punkt 9.1.3, in dem steht, worum es dabei geht.

8.1.2 (*...*) als Kommentar
Man kann auch Kommentare in (*...*) schreiben. Der Effekt ist im Prinzip der Gleiche wie eben bei {...}, nur, dass hier zwei Zeichen mehr (die beiden Sternchen) geschrieben werden müssen. Das Beispiel von eben mit dem neuen Kommentar:

PROCEDURE bis_zur_wand;    (* geht solange nach vorne, bis er an eine Wand kommt *)
BEGIN
 WHILE vorne_frei DO vor;
END;


Wir sehen, dass wir nichts sehen vom Kommentar und sind glücklich, dass es geklappt hat.

8.2 Sinn:
8.2.1 Wofür Kommentare?
Haben Kommentare eigentlich einen Sinn? Natürlich. In ihnen wird beschrieben, was eine Prozedur oder etwas anderes anstellt. Man muss immer bedenken: wenn man sein eigenes Programm in sechs Jahren wieder sieht, weiß man nicht mehr, was es macht. Aber sind Kommentare darin, hat man sofort wieder den Überblick.
Nun ist NIKI ja nicht wirklich schwer zu verstehen. Daher sind hier Kommentare vielleicht nicht wirklich immer sinnvoll, aber nützlich. Bei NIKI reicht es auch schon, wenn man einen aussagekräftigen Namen wählt (vgl. hierzu auch Kapitel 9, Punkt 9.3.1).