Tài liệu về Clojure cho thư viện/không gian tên

Question

Làm cách nào để thêm tài liệu và/hoặc nhận xét vào Clojure libaries/namespaces nói chung, tức là không chỉ cho các chức năng cụ thể trong không gian tên?

Tôi đã nhận thấy rằng nguồn clojure sử dụng (comment ...) ở một số nơi để thực hiện việc này (example), được khuyến nghị?

Answer 1

Bạn có thể thêm nó vào khai ns:

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

Ví dụ bạn liên kết đến nào đó quá - vì vậy không chắc chắn nếu điều này là những gì bạn nghĩa là gì? Nhưng tôi nghĩ đó là "tiêu chuẩn" nhất - nó sẽ được chọn bởi các hệ thống tài liệu như Codox và Autodoc.

Answer 2

Bạn có thể thêm chuỗi tài liệu vào bất kỳ không gian tên nào ở dạng ns.

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