Documentación de Clojure para bibliotecas/espacios de nombres.

documentation docstring

Question

Cómo agregar cadenas de documentación y / o comentarios a Clojure Libaries / espacios de nombres en su conjunto, es decir, no sólo para funciones específicas dentro del espacio de nombres?

Me he dado cuenta de que la fuente de clojure se usa (comment ...) en algunos lugares para hacer esto ( example ), ¿se recomienda?

Answer 1

Puede agregar una cadena de documentos a cualquier espacio de nombres en el formulario ns .

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

Answer 2

Puedes añadirlo a la declaración ns :

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

El ejemplo al que se vincula también lo hace, ¿no está seguro de si esto es lo que quiere decir? Pero creo que es el más "estándar": será recogido por sistemas de documentación como Codox y Autodoc .