配置您的编辑器

OCaml 为许多编辑器提供了插件,但最活跃的维护的是 Visual Studio Code、Emacs 和 Vim。

Visual Studio Code

TL;DR

安装 VSCode 扩展 ocamllabs.ocaml-platform 以及 ocaml-lsp-serverocamlformat 包到您的 opam 切换 中。

从 Visual Studio Marketplace 安装 OCaml Platform Visual Studio Code 扩展

此扩展依赖于 OCaml LSP 和 ocamlformat。要在您的切换中安装它们,您可以运行以下命令

$ opam install ocaml-lsp-server ocamlformat

首次加载 OCaml 源文件时,系统可能会提示您选择所使用的工具链。从列表中选择您正在使用的 OCaml 版本,例如 4.14.0。

可用的编辑器功能

如果您的编辑器已正确设置,以下是一些您可以开始使用的重要功能,以发挥您的优势

1) 悬停以获取类型信息

VSCode Hovering

这是一个非常棒的功能,它允许您查看任何 OCaml 变量或函数的类型信息。您只需将光标放在代码上,信息就会显示在工具提示中。

2) 使用 Ctrl + 点击 跳转到定义

VSCode Ctrl click

如果您在悬停时按住 Ctrl 键,代码会显示为可点击的链接,点击后会将您带到实现所在的 文件。如果您想了解一段代码的内部工作原理,这将非常有用。在此示例中,将光标悬停在 Queue 模块的 peek 方法上并 Ctrl + 点击 它会将您带到 peek 方法本身的定义以及它的实现方式。

3) 使用 Ctrl + Shift + P 执行 OCaml 命令

VSCode OCaml Commands

按下组合键 Ctrl + Shift + P 会在顶部打开一个模态对话框。如果您键入 ocaml,您将看到一个列表,其中包含各种可供您使用的 OCaml 命令,这些命令可以用于不同的目的。

Windows 用户

如果您使用的是 DkML 发行版,您需要:1. 转到 文件 > 首选项 > 设置 视图(或按 Ctrl ,)2. 选择 用户 > 扩展 > OCaml Platform 3. 取消选中 OCaml: Use OCaml Env。就这样!

Vim 和 Emacs

**对于 Vim 和 Emacs**,我们不会使用 LSP 服务器,而是直接与 Merlin 交谈。

$ opam install merlin

在上面安装 Merlin 后,将打印有关如何将 Merlin 与您的编辑器链接的说明。如果您没有看到它们,只需运行以下命令

$ opam user-setup install

与 Merlin 交谈

获取类型信息

Vim

Vim Type information

  • 在 Vim 编辑器中,按 Esc 进入命令模式。
  • 将光标放在变量上。
  • 键入 :MerlinTypeOf 并按 Enter
  • 类型信息将显示在命令栏中。Vim 中还有其他 Merlin 命令可用,您可以查看它们在 Merlin 的 Vim 官方文档 中的用法。

Emacs

Emacs Type information

  • 在 Emacs 编辑器中,将光标放在变量上。
  • 使用键盘快捷键 Alt + x,然后是 merlin-type-enclosing
  • 类型信息将显示在迷你缓冲区中。Emacs 中还有其他 Merlin 命令可用,您可以查看它们在 Merlin 的 Emacs 官方文档 中的用法。

帮助改进我们的文档

所有 OCaml 文档都是开源的。发现错误或不清楚的地方?提交一个拉取请求。

OCaml

创新。社区。安全。