我正在使用Eclipse和OcaIDE-Plugin来编写我的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*)
不幸的是，我的评论没有显示，当我在其中一个功能上按F2时，它只显示名称及其包含的文件。
在mli文件中编写注释时，它按预期工作，但我也想记录无法从外部访问的“私有”函数。我可以在mli中定义不能从外部访问的函数，仅用于文档吗？
如何让Eclipse显示我的文档？
答案 0 :(得分：1)
好吧，正如您所说，您希望显示文档但不会将该功能导出模块。遗憾的是，这不起作用。
我猜OcaIDE可以被认为是不完整的，但它看起来并不像人们所关心的（我不知道一个人在OcaIDE工作）。如果您喜欢自动完成等，可以尝试使用emacs编程并安装merlin（看，我找到了适合您的完美帖子：here）
至于在mli中定义一个无法从外部访问的函数的建议，它完全反对为什么创建mli文件，所以不要指望这是可能的。 ; - ）
我希望我能够帮助你。