ocaml - 如何在 Core.Std 中查找文档？

Question

Core.Std 下的函数、符号的文档在哪里？

或者，有没有常规 查找 ocaml 文档而不是在 utop 中猜测的方法回复

例如。我知道如果 open Core.Std , 然后函数 String.split将被导入。但是很难找出函数参数等是什么。

另外，我猜，Ocaml 没有像 Haskell 那样指向它的文档的源代码链接。

目前最好的解决方案是看:https://ocaml.janestreet.com/ocaml-core/111.28.00/doc/core_kernel/#Core_string

Answer 1

Merlin能够执行文档查找并跳转到定​​义。我假设在 Emacs 中，您使用的是 Emacs，文档查找默认情况下未绑定(bind)到任何键，因此我将其绑定(bind)到 C-c C-d .将以下内容添加到您的 emacs 配置文件中:

(define-key merlin-mode-map (kbd "C-c C-d") 'merlin-document)
(define-key merlin-mode-map (kbd "C-c d") 'merlin-destruct)

查找函数会直接跳转到 mli文件。这是我最喜欢阅读文档的方式。不幸的是，由于 bug , Janestreet 停止运送 mli文件，因此该功能在核心上有些损坏。作为一种解决方法，您可以安装源代码

opam source core_kernel

然后创建一个 .merlin文件，并将其指向源:

S <path-to-sources>

通常，它会是这样的

S ../core_kernel.113.33.00/src

请注意，您应该将 merlin 直接指向源子文件夹。

还值得注意的是，梅林具有类似补全的智能，这对您有很大帮助，您可以点击 F1当您从完成列表中选择一个条目时，将弹出一个带有文档的窗口。

最后，您引用的文档链接非常过时。这是 latest documentation 的链接.