基于 doctest 生成 HTML 文档
因为生成文档是基于 markdown,所以你必须做两件事:
1 /编写 doctest 并明确提高 doctest 示例以提高可读性(最好给出标题,如示例或测试)。编写测试时,不要忘记为测试代码提供 4 个空格,以便将其格式化为 HTML 文档中的代码。
2 /然后,在 elixir 项目的根目录中的控制台中输入 mix docs
,以在位于 elixir 项目根目录的 doc 目录中生成 HTML 文档。
$> mix docs
因为生成文档是基于 markdown,所以你必须做两件事:
1 /编写 doctest 并明确提高 doctest 示例以提高可读性(最好给出标题,如示例或测试)。编写测试时,不要忘记为测试代码提供 4 个空格,以便将其格式化为 HTML 文档中的代码。
2 /然后,在 elixir 项目的根目录中的控制台中输入 mix docs
,以在位于 elixir 项目根目录的 doc 目录中生成 HTML 文档。
$> mix docs