如何在Core.Std中找到文档?

时间:2016-06-20 03:06:19

标签: ocaml

Core.Std下的函数,符号文档在哪里?

或者,是否有任何常规方式查找ocaml文档而不是在utop REPL中猜测?

E.g。我知道如果open Core.Std,则会导入函数String.split。但是很难找出函数参数等等。

另外,Ocaml没有像Haskell那样的文档的源代码链接,我想。

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

1 个答案:

答案 0 :(得分:3)

Merlin能够执行文档查找并跳转到定​​义。在Emacs中,我假设您正在使用Emacs,文档查找默认不绑定到任何键,因此我将其绑定到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直接指向源子文件夹。

值得注意的是,Merlin具有像完成一样的智能,这有很多帮助,当你从完成列表中选择一个条目时,你可以点击F1,并弹出一个带文档的窗口。

最后,您引用的文档链接已经过时了。以下是latest documentation的链接。