Eclipse 中 OCaml 代码的文档

Question

我正在使用带有 OcaIDE-Plugin 的 Eclipse 来编写我的 ocaml 项目。

我已经编写了几个想要记录的 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*)

不幸的是，我的 cmets 没有显示，当我在其中一个功能上按 F2 时，它只显示名称和它包含的文件。

在 mli 文件中编写 cmets 时，它按预期工作，但我还想记录无法从外部访问的“私有”函数。我可以在 mli 中定义无法从外部访问的函数吗，仅用于文档？

如何让 Eclipse 显示我的文档？

Answer 1

好吧，正如您所说，您想显示文档，但不想将函数导出到模块之外。遗憾的是，这行不通。

我想 OcaIDE 可以被认为是不完整的，但它看起来不像是人们关心的事情（我不认识一个在 OcaIDE 工作的人）。如果您喜欢自动完成等功能，可以尝试使用 emacs 编程并安装 merlin（看，我为您找到了完美的帖子：here）

关于在mli中定义一个外部无法访问的函数的建议，完全与为什么要创建mli文件相反，所以不要指望这是可能的。 ;-)

希望能帮到你。