設定你的編輯器
OCaml 有許多編輯器的外掛,但維護最積極的是 Visual Studio Code、Emacs 和 Vim。
Visual Studio Code
重點概要
在你的 opam switch 中安裝 VSCode 擴充功能
ocamllabs.ocaml-platform
以及套件ocaml-lsp-server
和ocamlformat
。
從 Visual Studio Marketplace 安裝 OCaml Platform Visual Studio Code 擴充功能。
此擴充功能依賴 OCaml LSP 和 ocamlformat。要在你的 switch 中安裝它們,你可以執行
$ opam install ocaml-lsp-server ocamlformat
首次載入 OCaml 原始碼檔案時,可能會提示你選擇正在使用的工具鏈。從列表中選擇你正在使用的 OCaml 版本,例如 4.14.0。
你可以使用的編輯器功能
如果你的編輯器設定正確,以下是一些你可以開始利用的重要功能
1) 懸停以查看類型資訊
這是一個很棒的功能,可讓你查看任何 OCaml 變數或函式的類型資訊。你只需將游標放在程式碼上方,它就會顯示在工具提示中。
Ctrl + Click
跳到定義
2) 使用 如果你在懸停時按住 Ctrl 鍵,程式碼會顯示為可點擊的連結,點擊後會帶你到實作所在的檔案。如果你想了解一段程式碼在底層是如何運作的,這會很有幫助。在這個範例中,懸停並在 Queue
模組的 peek
方法上按 Ctrl + Click
會帶你到 peek
方法本身的定義以及它的實作方式。
Ctrl + Shift + P
執行 OCaml 命令
3) 使用 按下組合鍵 Ctrl + Shift + P 會在頂部開啟一個模式對話方塊。如果你輸入單字 ocaml
,你將看到一系列可供你使用的各種 OCaml 命令,這些命令可用於不同的目的。
Windows 使用者
如果你使用 DkML 發行版,你需要:1. 前往 檔案
> 偏好設定
> 設定
視圖(或按 Ctrl ,
) 2. 選擇 使用者
> 擴充功能
> OCaml Platform
3. 取消勾選 OCaml: 使用 OCaml Env
。就這樣!
Vim 和 Emacs
對於 Vim 和 Emacs,我們不會使用 LSP 伺服器,而是直接與 Merlin 通訊。
$ opam install merlin
在上面安裝 Merlin 之後,會列印出如何將 Merlin 與你的編輯器連結的說明。如果你沒有看到它們,只需執行此命令
$ opam user-setup install
與 Merlin 通訊
取得類型資訊
Vim
- 在 Vim 編輯器中,按 Esc 進入命令模式。
- 將游標放在變數上方。
- 輸入
:MerlinTypeOf
並按 Enter。 - 類型資訊將顯示在命令列中。Vim 的其他 Merlin 命令可用,你可以在 Merlin 官方 Vim 文件中查看它們的使用方法。
Emacs
- 在 Emacs 編輯器中,將游標放在變數上方。
- 使用鍵盤快捷鍵 Alt + x,然後輸入
merlin-type-enclosing
- 類型資訊將顯示在小型緩衝區中。Emacs 的其他 Merlin 命令可用,你可以在 Merlin 官方 Emacs 文件中查看它們的使用方法。