documentation - 将文档字符串放在数据变量上，是否被认为是惯用的？

Question

所以我在我的 clojure 代码中定义了一些变量来保存状态数据。我刚刚发现我可以向这些变量添加一个文档字符串，例如:

(def ^{:doc "Documentation for *my-var*"}
        *my-var*)

那让我打电话 (doc *my-var*)在 REPL。这似乎是一件有效且有用的事情，但在我读过的(有限)代码中似乎并不常见。

这被认为是惯用的 clojure 吗？

Answer 1

从 clojure 1.3 开始，def允许一个可选的文档字符串。

(def *my-var*
  "My var does cool things (it really doesn't)."
  nil)