如何从 Elixir shell 获取 Erlang 函数的帮助

Question

在 iex 中，我无法获得内置 Erlang 函数的帮助，例如：

iex(1)> h :lists.reverse
:lists was not compiled with docs

有没有办法解决这个问题？

Answer 1

我编写了一个模块，试图从在 unix 系统上随 erlang 一起安装的 unix 手册页中提供尽可能多的 erlang 文档。

https://github.com/philosophers-stone/ehelper

使用示例：

iex(3)> e :lists.reverse

                             :lists.reverse(list1)

### reverse(List1) -> List2

Types:

List1 = List2 = [T]

T = term()

Returns a list with the elements in List1 in reverse order.


                          :lists.reverse(list1, tail)

### reverse(List1, Tail) -> List2

Types:

List1 = [T]

Tail = term()

List2 = [T]

T = term()

Returns a list with the elements in List1 in reverse order, with tail Tail
appended.

Example:

    > lists:reverse([1, 2, 3, 4], [a, b, c]).
    [4,3,2,1,a,b,c]

Answer 2

没有。没有。

Erlang 文档不同于 Elixir 文档。正如@whatyouhide 所说，这意味着编写一个Erlang 文档解析器并将其连接到控制台中的h/1。虽然并非不可能，但这需要一些工作。据我所知，没有人在做这件事。

正如@Onorio Catenacci 所说，他们确实接受公关，所以你（或其他人）可以改变这一点:)。

Answer 3

正如其他人所指出的，在 Elixir 中没有简单的方法可以做到这一点。但是，这里有一些捷径，它们可能对从 iex 检查 Erlang 模块中可用的功能很有用（尽管这些都不能真正访问任何文档）。

给定的 Erlang 模块提供了哪些功能？

要列出 Erlang 模块导出的所有函数，请使用 module_info 函数，例如：

Enum.each :lists.module_info(:exports), &IO.inspect/1

这将打印函数名称及其数量的列表。

Erlang 函数接受哪些参数？

要大致了解一下，您可以使用 s 命令从 iex 打印 Erlang 函数的规范信息：

iex(1)> s :lists.reverse
@spec reverse(list1, tail) :: list2 when List1: [t], Tail: term(), List2: [t], T: term(), list1: var, tail: var, list2: var
@spec reverse(list1) :: list2 when List1: [t], List2: [t], T: term(), list1: var, list2: var

当然，查找在线文档可能是最好的方法。