Eclipse中的OCaml代碼文檔

Question

我將Eclipse與OcaIDE-Plugin結合使用來編寫ocaml-project。

我已經寫了幾個要記錄的ocaml函數（注釋，返回值和參數）。

我已經在.ml文件中創建了此鏈接中所述的文檔： http ://caml.inria.fr/pub/docs/manual-ocaml/ocamldoc.html

這是一個功能的示例：

(** sorting tuples where first element is key *)
let my_comp x y = (*Some code*)

不幸的是，我的評論沒有顯示，當我在其中一個功能上按F2時，它僅顯示名稱和包含的文件。

當在mli文件中編寫注釋時，它可以按預期工作，但是我也想記錄無法從外部訪問的“私有”功能。 我可以在mli中定義不能從外部訪問的僅用於文檔的功能嗎？

如何使Eclipse顯示文檔？

Answer 1

嗯，正如您所說，您想顯示文檔，但不希望將功能導出到模塊之外。 不幸的是，那是行不通的。

我猜OcaIDE可以被認為是不完整的，但看起來並不是人們關心的事情（我不知道一個人在OcaIDE上工作）。 如果您喜歡自動補全等功能，則可以嘗試使用emacs進行編程並安裝merlin（看，我找到了最適合您的文章： 此處 ）

至於在mli中定義一個無法從外部訪問的函數的建議，這與為什么創建mli文件完全相反，因此不要期望這樣做。 ;-)

我希望能為您提供幫助。