Wie fügen Sie Docstrings und/oder Kommentare zu Clojure-Bibliotheken/Namespaces als Ganzes hinzu, d. H. Nicht nur zu bestimmten Funktionen im Namespace?Clojure-Dokumentation für Bibliotheken/Namespaces
Ich habe festgestellt, dass die Clojure-Quelle an einigen Stellen (comment ...) verwendet (example), ist das zu empfehlen?
Sie können hinzufügen, um es in die ns Erklärung:
(ns ^{:author "mikera"
:doc "My awesome library"}
foo.bar.core)
Das Beispiel Sie einen Anknüpfungspunkt das auch - so nicht sicher, ob dies ist, was du meinst? Aber ich denke, es ist der "Standard" - es wird von Dokumentationssystemen wie Codox und Autodoc aufgenommen.
Sie können einem beliebigen Namespace im Formular ns einen DocString hinzufügen.
(ns my.name.space
"Very cool namespace doing this and that."
(:require other.cool.stuff))
In der Tat. Und wenn Codox es ablehnt, es in den HTML-Dateien erscheinen zu lassen, versuchen Sie es mit einem "Lein clean". – Gra
Link zu Codox https://github.com/weavejester/codox, nur übrigens –
anzumerken, dass 'ns' wird [definiert] (http://clojure.github.io/clojure/clojure.core-api.html#clojure.core/ns) ein docstring als optionaler zweiter aufzunehmen Streit. Diese Antwort entspricht [Kotaraks Antwort] (http://stackoverflow.com/a/11611325/122762). –