ocaml 的编译器文档答案

【问题标题】：ocaml's compiler's documentationocaml 的编译器文档
【发布时间】：2012-07-25 22:54:52
【问题描述】：

有没有人尝试过为 ocaml 的编译器构建 ocamldoc 的文档？

最近阅读源代码树，我可以大致了解它是如何工作的，但它会是如果有一些文档很好，因为我担心我可能会错过一些东西。无论是英语还是法语对我来说没问题

非常感谢

【问题讨论】：

（记录在案，如果您从这里得到答案，请告诉我们1771.in/ocamls-compilers-documentation-2.html）
我把文档放在这里（现在你可以在你的 ipad 中阅读编译器）seas.upenn.edu/~hongboz/hongbo_zhang_files/typing.docdir/…

【解决方案1】：

【讨论】：

【解决方案2】：

我在源代码树中看到的唯一 ocamldoc cmets（它们以 (** 开头并遵循一些格式）在 ocamlbuild/、ocamldoc/ 和 stdlib/ 中。

特别是在asmcomp/, asmrun/, bytecomp/, parsing/...中没有这样的cmets。

因此，根据您对 ocaml 编译器的哪个部分感兴趣，ocamldoc 文档可能不存在。

这看起来很有趣：http://rwmj.wordpress.com/2009/08/04/ocaml-internals/，但它是为初学者准备的，你可能已经不是了。

【讨论】：

是的。我的文档意味着保留代码的 html 输出。我设法构建了文档，但 ocamldoc 更喜欢 .mli 而不是 .ml，这使得 --keep-code 不是很有用。完成后，我会很乐意分享