Function ocamldoc是否为函数生成文档?

Function ocamldoc是否为函数生成文档?,function,ocaml,documentation,ocamldoc,Function,Ocaml,Documentation,Ocamldoc,我正在使用ocamldoc生成程序的文档。我的代码还不是特别大,我只有一个函数,但是当我打开HTML时,函数文档不会出现在ocamldoc生成的任何文件中 我使用ocamldoc-all params arbol\binario.ml生成HTML 我阅读了ocamldoc的文档,并使用了标志-all-params,但它也不起作用。我还创建了一个简单的非递归函数,但输出相同 (** @author Roldan Rivera Luis Ricardo @author Foo*) (**Este

我正在使用ocamldoc生成程序的文档。我的代码还不是特别大,我只有一个函数,但是当我打开HTML时,函数文档不会出现在ocamldoc生成的任何文件中

我使用
ocamldoc-all params arbol\binario.ml
生成HTML

我阅读了ocamldoc的文档,并使用了标志
-all-params
,但它也不起作用。我还创建了一个简单的非递归函数,但输出相同

(** @author Roldan Rivera Luis Ricardo
@author Foo*)

(**Este modulo contiene la implementacion de una arbol binario 
de busqueda BST (acrónimo del inglés Binary Search Tree)
con sus funciones basicas.

{b funciones}
- {! Crear}
- {! Insertar}
- {! Buscar}
- {! Recorrer}*)

(** Tipo de dato llamado Tree, la notacion 'a (alfa) indica que es un
tipo de dato polimorfico, es decir que puede soportar
cualquier tipo de dato. *)

type 'a tree =
    | Branch of 'a * 'a tree * 'a tree (** Un elemento * sub-arbol izquierdo * sub-arbol derecho *)
    | Leaf (** El fin de una rama, significa que ya no hay mas sub-arboles, equivalente al Nil *)

(** Busca el dato deseado en el arbol
 @param tree Arbol donde se va a realizar la busqueda
 @param x El valor a buscar
 @return None Si no se encuentra el dato en el arbol*)
let rec buscar tree x =
match tree with
| Leaf -> None
| Branch(k,left,right) ->
    if k = x then Some x
    else if x < k then buscar left x
    else buscar right x
(***作者Roldan Rivera Luis Ricardo
@作者Foo*)
(**Este模块控制实现了一个二元结构
de busqueda BST(acrónimo del inglés二进制搜索树)
基本功能。
{b函数}
-{!Crear}
-{!插入器}
-{!公共汽车}
-{!Recorrer}*)
(**Tipo de dato llamado Tree,la notacion'a(阿尔法)indica que en
这是警察局的最新情况
cualquier tipo de dato.*)
键入“一棵树”=
|“a*”树*a树的分支(**Un elemento*sub arbol izquierdo*sub arbol derecho*)
|叶(**无叶,无叶,相当于无叶*)
(**Busca el dato deseado en el arbol
@在布斯奎达的一棵树上
@帕拉姆x埃尔瓦勒公共汽车
@返回None Si no se ENCUNTRA el dato en el arbol*)
让rec巴士树x=
匹配树
|叶->无
|分支(k、左、右)->
如果k=x,那么一些x
否则,如果x
您是否忘记精确定义html后端(也不应该在模块名称中添加空格)

使用运行ocamldoc

ocamldoc -html -all-params filename.ml
应打印功能的以下文档:

val-buscar:'a->'a->'a选项
巴斯卡·达托·德塞多·恩埃尔·阿尔波尔酒店

  • 返回None Si no se ENCUNTRA el dato en el arbol
参数: 树 : 'a 在布斯奎达的一家酒店 x : 'a 埃尔瓦勒公共汽车
究竟是什么问题?据我所见,生成的带有
ocamldoc-html filename.ml
的html文件确实包含了
buscar
函数的文档。另外,
ocamldoc-version
可能是一个好主意,在html:c、[link]()中没有用于buscar的文档@octachron,您是否有生成函数文档的代码示例?
<pre><span id="VALbuscar"><span class="keyword">val</span> buscar</span> : <code class="type">'a <a href="A.html#TYPEtree">tree</a> -> 'a -> 'a option</code></pre><div class="info ">
<div class="info-desc">
<p>Busca el dato deseado en el arbol</p>
</div>
<ul class="info-attributes">
<li><b>Returns</b> None Si no se encuentra el dato en el arbol</li>
</ul>
</div>
<div class="param_info"><table border="0" cellpadding="3" width="100%">
<tr>
<td align="left" valign="top" width="1%"><b>Parameters: </b></td>
<td>
<table class="paramstable">
<tr>
<td align="center" valign="top" width="15%" class="code">
tree</td>
<td align="center" valign="top">:</td>
<td><div class="paramer-type">
<code class="type">'a <a href="A.html#TYPEtree">tree</a></code><div>
Arbol donde se va a realizar la busqueda
</tr>
<tr>
<td align="center" valign="top" width="15%" class="code">
x</td>
<td align="center" valign="top">:</td>
<td><div class="paramer-type">
<code class="type">'a</code><div>
El valor a buscar
</tr>
</table>
</td>
</tr>
</table></div>