有没有办法为BuckleScript或Reason生成代码文档?我尝试过使用ocamldoc
,但我不知道如何自动包含节点包依赖项。
答案 0 :(得分:3)
节点包尚未自动解决。您可以在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
。
答案 1 :(得分:0)
有一种工具可以自动执行@Yawar描述的ocamldoc
的许多编排,称为BsDoc。
请注意,我本人并没有使用过它。但这应该是许多BuckleScript特定项目的首选(即,将bsb
与安装了npm
的依赖项一起使用,而不是dune
与安装了opam
的依赖项依赖性。)