简单地说,假设我有以下 OCaml 文件,名为test.ml
:
(**
[Test] is a sample module for showing the problem I am having with @ tags with OCamlDoc
*)
(**
[id] is the identity function. For any argument [x], [id x] is [x].
@param x The argument, which will be returned
@return The argument [x]
*)
let id (x: 'a): 'a = x
如果我运行命令ocamldoc -html -all-params -colorize-code test.ml
来获取Test
模块的文档,我会得到以下结果:
可以看出,对于参数信息,它()
作为参数的名称,并且由于某种原因不包括对参数的描述。
我不确定为什么参数名称和描述没有正确显示。