Ich bin ein College-Student an einer Schule, die hauptsächlich in Java unterrichtet. Eine der Stärken von Java, die ich sehr genieße, ist die große Sammlung von Bibliotheken. Was diese Bibliotheken besonders nützlich macht, ist die umfangreiche Dokumentation und Organisation, die über JavaDoc präsentiert wird. Gibt es Bibliothekssammlungen für Common Lisp, die ebenfalls diese Eigenschaften aufweisen, und gibt es ein JavaDoc ähnliches Tool, das beim Erstellen, Beibehalten oder Erweitern dieser Bibliotheken behilflich ist?
Nein, es gibt keine umfassende, konsistent dokumentierte Bibliothekssammlung. Die Inexistenz einer solchen Sache ist das größte Problem von Common Lisp. Wenn Sie daran interessiert sind, der Lisp-Community zu helfen, ist dies möglicherweise die erste Angriffsform.
Auch wenn es verschiedene JavaDoc-Entsprechungen gibt, gibt es keinen weitgehend akzeptierten Quasi-Standard wie für Java.
Github enthält eine Menge Lispeprojekte, ganz zu schweigen von Sourceforge
Probieren Sie cliki oder common-lisp.net.
Was Javadoc betrifft ... wissen Sie über Docstrings? Wenn nicht, finde es heraus. Informieren Sie sich auch über alle anderen selbstdokumentierenden Funktionen.
Es klingt, als hättest du die Spezifikation nicht gelesen. Lesen Sie immer die Spezifikation, was auch immer Sie tun.
Ich empfehle clbuild , das eine Sammlung von Qualitätsbibliotheken enthält, die von einer Gruppe erfahrener, scharfsinniger Lisp-Programmierer zusammengestellt wurden (wie sowie ein Skript zum Herunterladen und Installieren dieser Bibliotheken).
Wenn Sie Richtlinien zum Schreiben von Highlevel / API-Dokumenten benötigen, schlage ich vor, dass Sie den Beispielen von Edi Weitz und anderen folgen (siehe z. B. Hunchentoot , Vecto ).
Für die Implementierungsdokumentation auf niedrigerer Ebene denke ich, dass der eingebaute Docstring-Mechanismus zusammen mit Slime Quellennavigation und Autodoc funktioniert Einrichtungen umfassen die beste existierende Umgebung für Code-Exploration.
Es gibt viele verfügbare Bibliotheken für Common Lisp und viele davon sind ausführlich dokumentiert. JavaDoc ist nach meiner eigenen Erfahrung (oder einem solchen Tool wie Doxygen for C ++) kein wertvolles Werkzeug, um eine Bibliothek zu dokumentieren, sondern um ihre Implementierung zu dokumentieren.
Die Dokumentation ist also keine Frage der Werkzeuge, sondern des Willens des Lib-Autors, ein anständiges Handbuch zu schreiben. In diesem Bereich ist Common Lisp wie jede andere Sprache: Es gibt schöne Stücke der Technik mit wundervoller Dokumentation, schnellem und schmutzigem Code ohne das geringste Anzeichen von Dokumentation, sowie alle möglichen Kombinationen von Code- und Dokumentationsqualitäten ...
>Alles in allem fand ich persönlich heraus, dass Common-Lisp-Bibliotheken eine ziemlich hohe Gesamtqualität haben.
Tags und Links lisp common-lisp documentation-generation