OCaml 文档工具生成文档

OCaml 生态里面,最主要的文档工具是odoc,我们看下如何利用dune来生成文档

先装odoc

opam install odoc

 

装好了之后,生成文档的命令是

dune build @doc

 

生成的文档位于 _build/default/_doc/_html/index.html

mac下面,我们可以用一个命令串起来

dune build @doc && open _build/default/_doc/_html/index.html

文档生成之后,会打开浏览器,打开文档html,自己可以直接看文档

 

写文档,需要注意,你需要在mli,也就是interface 文件里面写文档

尽量写详细一点

 

分类: 默认 标签: 发布于: 2022-06-29 11:23:53, 更新于: 2022-06-29 11:23:53