如何在 Common Lisp REPL 中查看文档字符串和其他符号信息？

Question

我对 CL 完全陌生，我想学习如何阅读文档字符串并从 REPL 获取其他帮助信息。类似于 Python 中的 help(symbol) ，或 iPython 中的 symbol? ，或 :t 和 :i哈斯克尔的 GHCi。

因此，给定一个符号名称，我希望能够知道：

• 它绑定到什么类型的值，如果有的话（函数，变量，根本没有）
• 如果它是函数或宏，那么什么是它的位置参数（
• 如果它有文档字符串），显示
• 它来自哪个包或文件，或者定义它的时间

我发现有 (documentation '_symbol_ '_type_)，但它并不完全是我需要。我需要先知道符号绑定到的值的类型（'function、'variable、'compiler-macro 等）我可以使用文档。然后它仅返回文档字符串，它可能会丢失或不足以使用该符号。

例如，在 Lisp 中，mapcar 的帮助不是很有用（CLisp 的 REPL）：

> (documentation 'mapcar 'function)
NIL

我希望能够看到类似这样的内容：

>>> map?
Type:       builtin_function_or_method
Base Class: <type 'builtin_function_or_method'>
String Form:    <built-in function map>
Namespace:  Python builtin
Docstring:
    map(function, sequence[, sequence, ...]) -> list

    Return a list of the results of applying the function to the items of
    the argument sequence(s).  If more than one sequence is given, the
    function is called with an argument list consisting of the corresponding
    item of each sequence, substituting None for missing values when not all
    sequences have the same length.  If the function is None, return a list of
    the items of the sequence (or a list of tuples if more than one sequence).

Answer 1

如前所述，Common Lisp 具有标准函数：DESCRIBE、INSPECT 和 文档。典型的 Lisp IDE 也将它们绑定到按键和菜单。

对于标准 Common Lisp 功能，大多数 IDE 通过按键直接链接到 Common Lisp HyperSpec 文档。

大多数 IDE 还可以通过击键来显示参数列表和文档。还有“空间参数列表”功能。

LispWorks 具体示例： LispWorks 参数列表信息和LispWorks表达式菜单

我建议阅读 Slime 的 IDE 手册, LispWorks 编辑器, Allegro CL 的 ELI，或您正在使用的任何 IDE。

Answer 2

关于您有关获取符号类型的问题：没有这样的事情。或者，更准确地说，符号不仅仅是其他对象的名称，而且本身也是 符号。每个符号可以同时具有变量值和函数值。要检查它是否具有变量值，请使用 BOUNDP，并且检查函数值FBOUNDP。