Kütüphaneler/ad alanları için Clojure belgelendirmesi

Question

Closture libaries/namespaces belgesine docstrings ve/veya yorumlar nasıl eklenir, yani sadece ad alanındaki belirli işlevler için değil?

Bunu yapmak için clojure kaynağının bazı yerlerde (comment ...) kullandığını fark ettim (example), önerilir mi?

Answer 1

Bunu ns ilanı ekleyebilirsiniz:

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

bağlanmak örnek de bunu yapar - Bu ne demek kadar emin değilse? Ama bence bu en "standart" - Codox ve Autodoc gibi dokümantasyon sistemleri tarafından alınacaktır.

Answer 2

ns formundaki herhangi bir ad alanına bir docstring ekleyebilirsiniz. ns` [tanımlandığı gibidir] olduğu

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