Kommentare in GDL (Geometric Description Language) sind weit mehr als nur Notizen am Rand — sie sind ein integrales Werkzeug für Lesbarkeit, Wartbarkeit und Zusammenarbeit. Hier ist eine strukturierte Übersicht:
Syntax: In GDL werden Kommentare mit einem Ausrufezeichen eingeleitet: ! Das ist ein Kommentar. Alles hinter dem ! auf dieser Zeile wird vom Interpreter ignoriert.
Die fünf Einsatzbereiche im Detail
1. Dokumentationsblock am Scriptanfang
Jedes GDL-Script sollte mit einem strukturierten Header beginnen, der auf einen Blick erklärt, was das Objekt ist, wer es erstellt hat und was geändert wurde:
! ============================================================
! Script: Fenster_parametrisch.gsm — 3D-Script
! Autor: Max Mustermann
! Datum: 2024-03-15
! Version: 2.3
! Zweck: Parametrisches Fenster mit variablen Sprossen
! Änderung: V2.3 — Kämpfer-Option hinzugefügt
! ============================================================Ohne diesen Block muss man das gesamte Script lesen, um zu verstehen, was es überhaupt tut — besonders problematisch bei Objekten, die man Monaten später wieder öffnet oder von Kollegen übernimmt.
2. Abschnittstrennlinien zur Strukturierung
GDL-Scripte können schnell mehrere hundert Zeilen lang werden. Visuelle Trennlinien machen Abschnitte navigierbar — ähnlich wie Kapitelüberschriften in einem Buch:
! === PARAMETER-BERECHNUNGEN ===
h_rahmen = h - 0.06
b_rahmen = w - 0.04
! === GEOMETRIE — RAHMEN ===
BLOCK b_rahmen, d, h_rahmen
! === GEOMETRIE — VERGLASUNG ===
CUTPLANE ...3. Inline-Kommentare — keine "Magic Numbers"
Nackte Zahlen im Code sind eine der häufigsten Fehlerquellen. Wer weiß drei Monate später noch, warum 0.04 oder 255 steht?
! Schlecht:
RGB_R = RGB_R / 255
! Gut:
RGB_R = RGB_R / 255 ! Normierung: RGB 0–255 → GDL 0–1
! Schlecht:
n = 5
! Gut:
n = 5 ! Anzahl der Quersprossen (ungerade = symmetrisch)4. Debugging — Code deaktivieren ohne zu löschen
Ein enormer praktischer Vorteil: Man kann Geometrie-Varianten oder Test-Ausgaben mit ! auskommentieren, ohne sie zu löschen. So lassen sich Alternativen direkt im Script aufbewahren:
BLOCK w, h, d ! Aktive Variante: Quader
! CYLINDER w/2, h ! Test-Variante: Zylinder
! ADD 0, 0, d ! zugehörige Verschiebung5. Bedingte Abschnitte erklären
Gerade bei IF/ENDIF-Konstrukten hilft ein Kommentar enorm, die Logik sofort zu verstehen:
IF typ = 1 THEN ! Typ 1 = Holzrahmen
...
ELSE ! Typ 2 = Aluminiumrahmen
...
ENDIFWichtige Einschränkungen
Im Vergleich zu PHP, Python oder anderen Sprachen hat GDL einen wesentlichen Unterschied: es gibt keinen Block-Kommentar. In Python schreibt man """...""", in PHP /* ... */ — in GDL muss jede einzelne Zeile mit ! beginnen. Das ist beim Auskommentieren größerer Abschnitte umständlich, lässt sich aber mit einem guten Texteditor (Sublime Text, VS Code) per Tastenkürzel lösen.
Fazit: Kommentare kosten beim Schreiben ein paar Sekunden — beim Warten, Debuggen oder Übergeben eines Scripts sparen sie Stunden. In professionellen GDL-Bibliotheken (z.B. von GRAPHISOFT selbst) sind gut kommentierte Scripts deshalb das Qualitätsmerkmal schlechthin ;-).