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和安裝梅林（看，我發現你的完美職位：here）

至於定義一個函數在外部不能訪問的mli的建議，它完全反對爲什麼創建mli文件，所以不要指望這是可能的。 ;-)

我希望我能夠幫助你。