库/名称空间的Clojure docstring

如何将docstring和/或注释作为一个整体添加到Clojure库/名称空间，即不只是添加到名称空间中的特定函数

---

我注意到clojure源代码在某些地方使用

（comment…

来执行此操作（），建议这样做吗？

您可以将其添加到

ns

声明中：

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

---

您链接到的示例也会这样做-所以不确定这是否是您的意思？但是我认为它是最“标准的”-它将被诸如和之类的文档系统使用。

您可以在

ns

表单中的任何名称空间中添加docstring

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

---

请注意，

ns

将docstring作为可选的第二个参数。这个答案相当于。如果Codox拒绝将其显示在html文件中，请尝试

lein clean

。