Documentazione Clojure per librerie/spazi dei nomi

Question

Come aggiungere docstring e/o commenti alle librerie Clojure/namespace nel loro insieme, cioè non solo a funzioni specifiche all'interno del namespace?

Ho notato che la fonte del clojure utilizza (comment ...) in alcuni punti per farlo (example), è quella consigliata?

Answer 1

Si è possibile aggiungere alla dichiarazione ns:

(ns ^{:author "mikera" 
     :doc "My awesome library"} 
    foo.bar.core) 

L'esempio si collega a fa anche questo - quindi non so se questo è quello che vuoi dire? Ma penso che sia il più "standard" - verrà raccolto da sistemi di documentazione come Codox e Autodoc.

Answer 2

È possibile aggiungere una docstring a qualsiasi spazio dei nomi nel modulo ns.

(ns my.name.space 
    "Very cool namespace doing this and that." 
    (:require other.cool.stuff))