Question

我正在使用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

Answer 1

您是否忘了精确调整html后端（您也不应在模块名称中放置空格）？

使用

运行ocamldoc

ocamldoc -html -all-params filename.ml

应为该功能打印以下文档：

<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>

ocamldoc是否生成功能文档？

1 个答案: