2

我是 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 信息?

注意:我读到 API 文档存储在库中,您必须导入它们才能访问它

4

2 回答 2

3

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 中,您可以使用slime-describe-symbolswank 通过快捷方式访问C-c C-d d

于 2012-08-15T07:36:24.893 回答
2

在 REPL 上使用doc, find-doc,函数,使用启动 repl。 顺便说一句:如果库 jar 不包含 .clj 文件,则不能使用它们。aproposlein repl

于 2012-08-15T07:30:49.247 回答