0

我通过nuget包管理器(visual studios 2017 15.7.3)将docfx.console安装到一个测试项目中。我的项目是一个 .net 库,它有一个带有一些 xml 文档的单一类。当我构建项目时,它会创建一个带有 .html 文件但没有文档的 _site 文件。它还生成一个 api、apidoc 和文章文件夹以及一个 docfx.json 文件。

项目抛出警告:无法在 obj/api/ 中找到 toc.yml 或 toc.md。确保该文件包含在配置文件 docfx.json 中!

我在 github 中发现了一些类似的问题,建议将我的 Visual Studio 版本设置为 2015,但是据我所知,此解决方案似乎不适用于 docfx.console。有谁知道我如何能够纠正这个问题?谢谢

4

1 回答 1

1

当我记录现有的 VB.net 解决方案时,我也偶然发现了这个问题。在不知道您的 docfx.json 文件是什么样子或您的 .NET 库是用 C# 还是 VB.net 编写的情况下,我只能提供一个解决我的问题的答案,也许会对您的问题有所帮助。

对我来说,通过 nuget 安装 docfx 时,docfx.json 文件默认设置为用于 C# 项目,而不是 VB.Net 项目。

我通过修改 docfx.json 文件并更改元数据文件源扩展名以搜索 *.vbproj 轻松解决了这个问题:

  "metadata": [
{
  "src": [
    {
      "files": [
        "*.vbproj"
      ],
      "cwd": ".",
      "exclude": [
        "**/obj/**",
        "**/bin/**",
        "_site/**"
      ]
    }
  ],
  "dest": "obj/api"
}],
于 2018-08-01T19:02:26.633 回答