BuckleScript项目的文档生成

Question

是否有任何方法为BuckleScript或原因生成代码文档？我尝试过使用ocamldoc，但我不知道如何自动包含节点包依赖项。

Answer 1

节点包还没有自动解析。您可以在ocamldoc命令中手动指定每个依赖包，例如：

ocamldoc -html -d doc -I node_modules/bs-webapi/lib/ocaml -I node_modules/bs-fetch/lib/ocaml -I node_modules/bs-platform/lib/ocaml src/YourModule.re

目录包含的内容是相当可预测的，您只需指向每个包中的lib/ocaml目录，ocamldoc就会找到它们编译的.cmi文件并从中获取所需的类型信息。

这也意味着您首先需要完成bsb -make-world，以编译所有这些.cmi。

Answer 2

据推测，有一个工具可以自动执行@Yawar所描述的ocamldoc的许多编排，称为BsDoc。

请注意，我自己并没有使用它；但它应该是许多特定于巴克利脚本的项目(即使用bsb和npm-installed依赖项，而不是dune与opam-installed依赖项)。