如何在 Clojure 中通过 def 定义的序列添加元/注释？

Question

我必须注释掉下面的行（示例来自 http://en.wikibooks.org /wiki/Clojure_Programming/Examples/Lazy_Fibonacci）

(def fib-seq
  ;"Implements Fibonacci sequence (starts with 0)."
  ((fn rfib [a b] 
     (lazy-seq (cons a (rfib b (+ a b)))))
   0 1))

如果我把它留在里面，我会得到：

Clojure 1.2.0
java.lang.Exception: Too many arguments to def (Problem1.clj:1)
1:1 user=>

但是，我可以使用 defn 来做到这一点。示例（我知道，我正在为 even? 重新发明轮子已经定义）：

(defn is-even? [n]
  "Returns true if the number is even, false otherwise."
  (== (mod n 2) 0))


Clojure 1.2.0
1:1 user=> (is-even? 3)
false
1:2 user=> (is-even? 4)
true
1:3 user=>

Answer 1

(def ^{:doc "延迟实现 Fib. 序列。"} fibs ...)

(:doc (meta (var fibs)))

; “延迟实现 Fib. 序列。”

---

编写宏非常简单，因此您可以编写 (def-with-docs foo "doc" 1)。

(defmacro def-with-docs [name docstring value]
  `(def ~(with-meta name {:doc docstring}) ~value))

(def-with-docs fib-seq "Implements Fibbonaci sequence (starts with 0)."
  ((fn rfib [a b] (lazy-seq (cons a (rfib b (+ a b))))) 0 1))

(:doc (meta (var fib-seq)))

; “实现斐波那契数列（从 0 开始）。”

---

另外，请注意，在使用 defn 的示例中，文档字符串应位于参数之前，否则它将不会与符号的相关联元数据。

---

或者，可以使用 clojure.contrib.def/ defvar。

Answer 2

这个问题已经在 Clojure 1.3 的新 alpha 版本中“修复”，其中 def 支持可选的文档字符串。

user> (clojure-version)
"1.3.0-alpha3"

user> (def answer "the answer to the final question" 42)
#'user/answer

user> (doc answer)
-------------------------
user/answer
nil
  the answer to the final question
nil

Answer 3

来自 http://clojure.org/special_forms#def

(def symbol init?) 创建并实习
或定位一个具有名称的全局变量
符号和值的命名空间
当前命名空间的。

来自 http://clojure.github.com/clojure/ clojure.core-api.html#clojure.core/defn

(defn name doc-string? attr-map?
[参数*] 主体）
与添加任何文档字符串或属性的 (def name (fn [params* ] exprs*)) 相同
到 var 元数据。

因此，当您编写 (def fib-seq "your comment" (...)) 时，您试图定义一个值为“your comment”的符号 fib-seq，并且 clojure 抱怨参数太多。