库/命名空间的Clojure文档

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

我注意到clojure源在某些地方使用(comment ...)来做到这一点（example），这是推荐的吗？

2012-07-23 mikera

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

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

您链接到的例子确实太 - 所以不知道这是什么意思？但我认为这是最“标准”的 - 它将被诸如Codox和Autodoc等文档系统所取代。

来源

2012-07-23 11:08:18 Gert

注意'ns'是[定义]（http://clojure.github.io/clojure/clojure.core-api.html#clojure.core/ns）取一个文档字符串作为一个可选的第二论据。这个答案相当于[kotarak的答案]（http://stackoverflow.com/a/11611325/122762）。 – 2014-02-24 23:43:04

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

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

来源

2012-07-23 11:08:36 kotarak

确实。如果Codox拒绝让它出现在html文件中，请尝试使用'lein clean'。 – Gra 2016-01-31 16:45:31

链接到codox https://github.com/weavejester/codox，只是btw – 2016-09-29 11:23:17

库/命名空间的Clojure文档

回答

相关问题