api - 获取 Clojure 库的 API 文档

Question

我是 Clojure 新手，我想知道所有文档在哪里对于所有库，例如在 clojars.org 上找到的库？

例如使用 lein 我对 project.clj 执行以下操作

(defproject Program-name "1.0.0-SNAPSHOT"
  :description "FIXME: write description"
  :dependencies [[org.clojure/clojure "1.3.0"]
   [facts/speech-synthesis "1.0.0"]
[org.clojars.jeffsigmon/maryclient "4.3.0"]
[speech-synthesis "1.0.0"]
[clarity "0.5.6"]])

然后使用lein deps安装所有库

核心.clj

(ns Program-name.core
(:use [speech-synthesis.say :as say])(use [clarity.component]))
(use 'clarity.form)

那么我该如何导入和获取 org.clojars.jeffsigmon/maryclient 的 API 信息呢？

note: I read that that the API documentation is stored in the libraries and you have to import them to access it

Answer 1

API文档以文档字符串的形式存在于代码中

例如

(defn my-func
 "This is the doc string"
 [a b c]
   ...)

您可以在 REPL 中访问文档字符串:

$ lein repl
user> (doc println)
-------------------------
clojure.core/println
([& more])
  Same as print followed by (newline)

user> (apropos "print")
(*print-radix* *print-miser-width* *print-pprint-dispatch* print-table 
  print-length-loop pprint-indent pprint *print-suppress-namespaces* 
  *print-right-margin* *print-pretty* with-pprint-dispatch ...)

user> (find-doc "print")
... lots of functions related to print with docs...

各种 IDE 也可以访问文档。例如在 emacs 中，借助 swank，您可以使用 slime-describe-symbol 通过快捷方式访问 C-c C-d d