这是一个示例接口test.mli
,注释了ocamldoc样式的注释:
(** ocamldoc module comment *)
open MissingModule;;
(** ocamldoc function comment *)
val test : unit;;
如果我运行命令ocamldoc test.mli
,我会收到以下错误:
File "test.mli", line 2, characters 0-9:
Error: Unbound module MissingModule
1 error(s) encountered
文档生成器为什么要关心未绑定的模块?
答案 0 :(得分:6)
这是因为ocamldoc
完全符合类型名称。文件:
open MissingModule
val f: foo -> unit
被翻译为
val f: MissingModule.foo -> unit
MissingModule.foo
成为foo
中MissingModule
定义的一个很好的交叉引用(如果missingModule.mli
作为ocamldoc
的参数给出。)< / p>
要完成答案,为了完全限定类型标识,您需要键入要处理的文件。因此ocamldoc
需要能够访问相应的.cmi
文件。