BuckleScript 项目的文档生成
Documentation generation for BuckleScript project
有什么方法可以为 BuckleScript 或 Reason 生成代码文档吗?我试过使用 ocamldoc
,但我不知道如何自动包含节点包依赖项。
节点包还没有自动解析。您可以在 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
。
据推测,有一个工具可以自动执行@Yawar 描述的 ocamldoc
的很多编排,称为 BsDoc。
请注意,我自己没有使用过它;但它应该是许多 BuckleScript 特定项目的首选(即使用 bsb
和 npm
-installed 依赖项,而不是 dune
和 opam
-installed依赖项。)
有什么方法可以为 BuckleScript 或 Reason 生成代码文档吗?我试过使用 ocamldoc
,但我不知道如何自动包含节点包依赖项。
节点包还没有自动解析。您可以在 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
。
据推测,有一个工具可以自动执行@Yawar 描述的 ocamldoc
的很多编排,称为 BsDoc。
请注意,我自己没有使用过它;但它应该是许多 BuckleScript 特定项目的首选(即使用 bsb
和 npm
-installed 依赖项,而不是 dune
和 opam
-installed依赖项。)