Lisp gehört zu den ältesten und gleichzeitig flexibelsten Programmiersprachen, die bis heute eine treue Anhängerschaft unter Programmierern weltweit genießen. Besonders Common Lisp hebt sich durch seine vielseitigen Möglichkeiten und seine Leistungsfähigkeit hervor. Trotz der hohen Ausdrucksmacht dieser Sprache bleibt die Einhaltung eines konsistenten Programmierstils entscheidend für die Wartbarkeit, Lesbarkeit und Weiterentwicklung von Quellcode. Genau hier setzt der sogenannte One True Lisp Style Guide an, der auf gemeinsamen Empfehlungen verschiedener angesehener Lisp-Stilführer basiert und versucht, einheitliche Regeln und Praktiken zu etablieren. Die Bedeutung eines einheitlichen Programmierstils in Lisp kann nicht hoch genug eingeschätzt werden.
Die Lesbarkeit von Code verbessert sich deutlich, wenn Entwickler einen gemeinsamen Nenner in ihrer Schreibweise finden. Zudem verhindern einheitliche Konventionen Fehlerquellen und erleichtern die Zusammenarbeit in Teams oder offenen Gemeinschaften. Dabei zielt der One True Lisp Style Guide nicht darauf ab, ein dogmatisches Regelwerk vorzugeben, sondern vielmehr, eine gemeinsame Basis für den guten Stil zu schaffen, die aus verschiedenen Quellen abgeglichen wurde. Ein zentraler Aspekt des Leitfadens ist die Dokumentation. In Lisp-Programmen sind Docstrings wichtiger als Kommentare, denn sie ermöglichen es, Funktionen, Klassen und Pakete direkt im Code zu erläutern und somit Anwendern und Entwicklern auf einfache Weise Hilfen bereitzustellen.
Diese Dokumentationsstrings sollten klar formuliert sein und den Zweck der jeweiligen Funktion oder Datei beschreiben. Kommentare hingegen dienen eher ergänzenden Erläuterungen, die nicht unmittelbar im Docstring untergebracht werden können. Dabei wird empfohlen, Kommentare konsistent nach einer gewissen Semikolon-Konvention zu verwenden. Inline-Kommentare erhalten ein Semikolon, zwischen Funktionsabschnitten werden zwei oder drei Semikolons genutzt, während Überschriften oder große Abschnitte mit vier Semikolons getrennt werden. Die Strukturierung des Codes wird zudem durch eine klare Vorgabe für die maximale Zeilenlänge unterstützt.
Für Lisp empfiehlt sich eine Begrenzung auf weniger als 100 Zeichen pro Zeile, wobei ein kürzerer Wert zu besserer Lesbarkeit führt. So bleibt der Code auch auf kleineren Displays oder in geteilten Fenstern gut lesbar, und der Entwickler wird zu klarer, prägnanter Gestaltung angehalten. Eine weitere wichtige Regel betrifft die Benennung von Variablen, Funktionen und Konstanten. Namen sollen möglichst aus vollständigen, kurzen und leicht verständlichen Wörtern bestehen, die durch Bindestriche getrennt werden. Das erleichtert das Nachvollziehen von Codeteilen und unterstützt die Suchbarkeit.
Für spezielle Variablen werden sogenannte "Earmuffs" verwendet, das heißt, sie werden von Sternchen umgeben (*beispiel-variable*), während Konstanten durch Pluszeichen umrahmt (+BEISPIEL-KONSTANTE+) erkennbar gemacht werden. Diese syntaktischen Markierungen helfen nicht nur bei der Identifikation der jeweiligen Symboltypen, sondern sind auch eine weithin anerkannte Konvention in der Lisp-Community. Die Definition von Funktionen sollte nach Möglichkeit keine Mischung von &optional- und &key-Argumenten enthalten, da dies zu unübersichtlichen Signaturen führt und die Funktion nicht intuitiv nutzbar macht. Stattdessen wird eine klare Trennung und präzise Argumentenstruktur empfohlen, um die Handhabung und den Aufruf komfortabler zu gestalten. In Lisp spielt die Nutzung von sogenannten Spezialvariablen eine besondere Rolle.
Diese dynamisch gebundenen Variablen sollten sparsam verwendet werden, denn ihr Einsatz birgt das Risiko von unerwartetem Verhalten und erschwert die Nachvollziehbarkeit des Programms. Wo immer möglich, ist es besser, lokale Variablen mit LET zu binden und Werte explizit zu übergeben. Die bewusste Reduzierung von Spezialvariablen erhöht die Robustheit und Lesbarkeit des Codes. Die Einhaltung von korrekter Einrückung ist ein weiteres essentielles Stilmerkmal. Moderne Lisp-Entwicklungsumgebungen wie Emacs bieten eine automatische, standardisierte Einrückung, die der Leser nutzen sollte.
Eine ordentliche Einrückung gibt dem Quellcode seine klare Struktur und hilft dabei, die vielen Klammern übersichtlich darzustellen – ein häufig genanntes Hindernis für Lisp-Neulinge. Im Hinblick auf die Programmierphilosophie legt der Leitfaden Wert darauf, kleine, zweckgebundene Funktionen zu schreiben, die jeweils nur eine klare Aufgabe erfüllen. Dies erhöht die Wiederverwertbarkeit, das Testen und das Debugging erheblich. Darüber hinaus wird empfohlen, Side-Effects möglichst zu vermeiden und stattdessen eine funktionale Denkweise zu fördern, bei der Daten unverändert bleiben und neue Daten durch Funktionsanwendung entstehen. Die Verwendung von EVAL, einem Lisp-Feature zur Ausführung generierten Codes, wird dagegen sehr kritisch gesehen.
In fast allen Fällen kann man auf sicherere und klarere Alternativen wie APPLY oder FUNCALL zurückgreifen. Ein Einsatz von EVAL zur Laufzeit sollte vermieden werden, da dies zu Sicherheitsrisiken und unerwarteten Seiteneffekten führen kann. Makros, eine der mächtigsten Eigenschaften von Lisp, sollten mit Bedacht eingesetzt werden. Der Leitfaden rät dazu, zunächst Funktionen zu verwenden und nur dann auf Makros zurückzugreifen, wenn es wirklich notwendig ist. Die Verwendung von Makros erfordert ein tiefes Verständnis ihrer Wirkungsweise und kann kompliziert sein, daher ist auch ein gewisser Respekt vor dieser Technik angebracht.
Die Organisation von Paketen und Bibliotheken wird ebenfalls adressiert. Generell ist es besser, nur die tatsächlich benötigten Symbole aus anderen Paketen mittels :import-from zu verwenden statt das gesamte Paket mit :use einzubinden. Das erhöht die Übersichtlichkeit und verhindert Namenskollisionen. Neuere Lisp-Implementierungen unterstützen Paket-interne Spitznamen, die als Best Practice gelten und den Umgang mit Namensräumen erleichtern. Fehlererkennung und der Umgang mit Bedingungen stellen einen wichtigen Bereich dar.
Es ist entscheidend zu verstehen, dass alle Fehler in Lisp Bedingungen sind, aber nicht alle Bedingungen Fehler darstellen. Eine geeignete Balance aus toleranter und strenger Fehlerbehandlung trägt zu stabileren Programmen bei. Bibliotheken spielen in der Lisp-Welt eine wichtige Rolle, da sie häufig optimierte und bewährte Lösungen bieten. Es wird geraten, vor der Entwicklung neuer Module zu prüfen, ob es bereits bestehende Bibliotheken für die zu lösenden Aufgaben gibt. Dies vermeidet unnötigen Entwicklungsaufwand und fördert den Austausch innerhalb der Lisp-Community.
Beim Thema Rekursion empfiehlt der Leitfaden, Iteration zu bevorzugen, sofern es sich nicht um rekursive Datenstrukturen handelt. Lisp bietet leistungsfähige iterative Konstrukte, die meist effizienter und einfacher nachvollziehbar sind als tief verschachtelte Rekursionen. Typdeklarationen stellen einen wichtigen Aspekt in der Verbesserung von Performance und Codeverständlichkeit dar. Wenn der Programmierer Informationen über die erwarteten Typen hat, sollte er diese explizit angeben. Dies hilft dem Compiler, effizienteren Maschinencode zu erzeugen, und gibt anderen Entwicklern wichtige Hinweise bezüglich der Daten.
Die Verwendung von bedingten Ausdrücken wird ebenfalls präzisiert. Es ist ratsam, Einwegbedingungen mit WHEN oder UNLESS zu schreiben und mehrzweilige Verzweigungen mit COND zu strukturieren. IF sollte nur bei zwei Alternativen angewandt werden. Diese Differenzierung macht den Code lesbarer und klarer. Predicate-Funktionen, die Bedingungen testen und einen Wahrheitswert zurückgeben, sollen im Namen die Endung "p" oder "-p" tragen.
Diese Namensgebung signalisiert sofort die Bedeutung des Rückgabewerts und verbessert die Verständlichkeit des Codes. Wichtig dabei ist die Beachtung der Schreibweise abhängig davon, ob der Funktionsname aus einem oder mehreren Wörtern besteht. Nicht zuletzt warnt der Leitfaden vor dem sogenannten "List Abuse", also der unüberlegten oder übermäßigen Verwendung von Listen an Stellen, an denen andere Datenstrukturen besser geeignet sind. Insbesondere bei Zugriffen, die zufällig auf Elemente zugreifen, sind Vektoren oder Arrays performanter als Listen. Auch Assoziationslisten sollten bei größerem Umfang durch Hashtabellen ersetzt werden, um die Effizienz zu steigern.
Zusammenfassend bietet der One True Lisp Style Guide eine wertvolle Orientierung für alle, die ihre Lisp-Programme sauber, effizient und lesbar gestalten möchten. Die Anwendung dieser Stilregeln erleichtert nicht nur die Zusammenarbeit, sondern trägt auch maßgeblich zur Qualität und Langlebigkeit von Softwareprojekten in Common Lisp bei. Wer diese Prinzipien beherzigt, legt den Grundstein für robusten und verständlichen Code, der auch in größerem Teamumfeld oder bei zukünftigen Erweiterungen einfach zu handhaben ist.
![Domain/OS Design Principles (1989) [pdf]](/images/1E5E6EAD-D0D8-4814-A356-4FED55AA17AE)
