如何在 Core.Std 中查找文档?
How to find documentation in Core.Std?
Core.Std 下函数、符号的文档在哪里?
或者,是否有任何常规方法来查找 ocaml 文档而不是在 utop
REPL 中猜测?
例如我知道如果open Core.Std
,那么函数String.split
就会被导入。但是很难找出函数参数等是什么
此外,我猜 Ocaml 没有像 Haskell 这样的文档的源代码链接。
当前最佳方案正在看:https://ocaml.janestreet.com/ocaml-core/111.28.00/doc/core_kernel/#Core_string
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
,然后点击 window文档将弹出。
最后,您引用的文档 link 非常过时。这是 link 到 latest documentation.
Core.Std 下函数、符号的文档在哪里?
或者,是否有任何常规方法来查找 ocaml 文档而不是在 utop
REPL 中猜测?
例如我知道如果open Core.Std
,那么函数String.split
就会被导入。但是很难找出函数参数等是什么
此外,我猜 Ocaml 没有像 Haskell 这样的文档的源代码链接。
当前最佳方案正在看:https://ocaml.janestreet.com/ocaml-core/111.28.00/doc/core_kernel/#Core_string
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
,然后点击 window文档将弹出。
最后,您引用的文档 link 非常过时。这是 link 到 latest documentation.