Eclipse 中的 OCaml 代码文档

Question

我使用带有 OcaIDE 插件的 Eclipse 来编写我的 ocaml 项目。

我已经编写了几个我想要记录的 ocaml 函数（评论，return 值和参数）。

我已经在 .ml 文件中创建了我的文档，如 link 中所述：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 文件中编写注释时，它按预期工作，但我还想记录无法从外部访问的 "private" 函数。我可以在 mli 中定义函数，这些函数不能从外部访问，只是为了文档吗？

如何使 Eclipse 显示我的文档？

Answer 1

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

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

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

希望能帮到你。