Documentación de Clojure para bibliotecas/espacios de nombres

Question

Cómo agregar cadenas de documentos y/o comentarios a Clojure libaries/namespaces como un todo, es decir, no solo a funciones específicas dentro del espacio de nombres?

He notado que la fuente clojure usa (comment ...) en algunos lugares para hacer esto (example), ¿eso es lo recomendado?

Answer 1

Puede añadirlo a la declaración ns:

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

El ejemplo se vincula a que hace demasiado - así que no sé si esto es lo que quiere decir? Pero creo que es el más "estándar": será recogido por los sistemas de documentación como Codox y Autodoc.

Answer 2

Puede agregar un docstring a cualquier espacio de nombre en el formulario ns.

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