Dokumentacja Clojure dla bibliotek/przestrzeni nazw

Question

Jak dodać docstrukcje i/lub komentarze do Clojure libaries/namespaces jako całości, tj. Nie tylko do konkretnych funkcji w przestrzeni nazw?

Zauważyłem, że źródło clojure używa (comment ...) w niektórych miejscach, aby to zrobić (example), jest to zalecane?

Answer 1

Możesz dodać to do deklaracji ns:

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

przykładzie połączyć się robi zbyt - więc nie wiem, czy to jest to, co masz na myśli? Ale myślę, że jest to najbardziej "standardowy" - zostanie pobrane przez systemy dokumentacji, takie jak Codox i Autodoc.

Answer 2

Możesz dodać docstring do dowolnej przestrzeni nazw w formularzu ns.

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