库/命名空间的 Clojure 文档字符串

Question

如何将文档字符串和/或 cmets 作为一个整体添加到 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 等文档系统采用。