库/名称空间的Clojure文档

Question

如何将文档字符串和/或注释作为一个整体添加到Clojure库/命名空间中，即不仅仅是命名空间中的特定函数？

我注意到clojure来源在某些地方使用(comment ...)来执行此操作（example），这是推荐的吗？

Answer 1

您可以将文档字符串添加到ns表单中的任何名称空间。

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

Answer 2

您可以将其添加到ns声明：

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

您链接的示例也是如此 - 所以不确定这是不是您的意思？但我认为它是最“标准”的 - 它会被Codox和Autodoc等文档系统选中。