【文件属性】：
文件名称：doctor:确保您的Elixir项目文档健康
文件大小：42KB
文件格式：ZIP
更新时间：2021-05-15 08:53:36
documentation-coverage typespecs Elixir
医生
使用Doctor确保您的文档健康！ 该库包含一个混合任务，您可以对项目运行该任务以生成文档覆盖率报告。 报告的项目包括：模块文档的存在，哪些功能没有文档，哪些功能没有类型规范，以及您的struct模块是否提供类型规范。 您可以生成一个.doctor.exs配置文件，以指定项目可以接受的阈值。 如果文档覆盖率下降到您指定的阈值以下，则mix doctor任务将返回非零退出状态。
使用此工具的主要动机是使一些简单的东西可以连接到CI中，以确保遵守和维护项目文档标准。 当您要保持文档覆盖率的最低阈值时，这在团队环境中特别有用。
安装
将:doctor添加到mix.exs中的依赖项列表中：
def deps do
[
{ :doctor , " ~> 0.17.0 " , only: :dev }
]
end
可以在上找到文档。
与其他工具的比较
Elixir生态系
【文件预览】：
doctor-master
----.doctor.exs(390B)
----.gitignore(576B)
----coveralls.json(51B)
----README.md(23KB)
----CHANGELOG.md(2KB)
----.github()
--------workflows()
--------FUNDING.yml(19B)
----test()
--------report_utils_test.exs(4KB)
--------module_information_test.exs(2KB)
--------sample_files()
--------configs()
--------test_helper.exs(15B)
--------mix_doctor_test.exs(21KB)
--------module_report_test.exs(7KB)
----LICENSE(1KB)
----config()
--------config.exs(1KB)
----mix.lock(5KB)
----lib()
--------reporters()
--------specs.ex(471B)
--------reporter.ex(216B)
--------mix()
--------module_information.ex(9KB)
--------cli()
--------report_utils.ex(5KB)
--------docs.ex(586B)
--------config.ex(2KB)
--------doctor.ex(468B)
--------module_report.ex(3KB)
----mix.exs(2KB)
----.formatter.exs(117B)