docfx 元数据步骤失败，出现错误“无法加载 SDK 解析程序”

Question

每当我尝试使用docfx构建任何留档时，我都会在元数据构建步骤中收到以下错误，该步骤使用msBuild来分析cspros代码中的xml注释：

警告：Metadata命令。ExtractMetadataWorkspace失败，原因是：[失败]处理文件“C：\temp\docfxtest\docfx_project\src\src.csproj”时MsBuild失败，并带有消息：无法加载SDK解析器。存在清单文件，但找不到SDK解析器DLL文件的路径。清单文件路径“C：\节目文件（x86）\Microsoft Visual Studio\2017\BuildTools\MSBuild\15.0\bin\SdkResolver\Microsoft. Build. NuGetSdkResolver\Microsoft.Build.NuGetSdkResolver.html" target="_blank">xml”。SDK解析器路径：C：\节目文件（x86）\Microsoft Visual Studio\2017\BuildTools\公共扩展\Microsoft\NuGet\Microsoft.Build.NuGetSdkResolver.dllC：\temp\docfxtest\docfx_project\src\src.csproj

docfx似乎无法正确解析msbuild。你知道我该怎么解决吗？

我在Windows上使用docfx版本2.56.5.0，我还安装了VS Enterprise 2019（16.8.2）和VS Build Tools 2017（15.9.29）：

更新：

我现在已经完全卸载了VS 2017的构建工具，并使用安装程序修复了VS 2019的安装。当我运行docfx时，我现在得到一个不同的错误。好像它再也找不到msbuild了。

警告：MetadataCommand.ExtractMetadataWorkspace 失败，并显示： [失败] Msbuild 在处理文件“C：\temp\docfxtest\docfx_project\src\src.csproj”时失败，并显示消息：找不到指定的 SDK “Microsoft.NET.Sdk”。C：\temp\docfxtest\docfx_project\src\src.csproj

运行< code>msbuild -t:restore，build也显示它找不到msbuild

“msbuild”未被识别为内部或外部命令

目标不是：

.NET核心工作负载也是如此：

Answer 1

我已经使用chocolatey完全卸载了docfx（＜code＞choco uninstall docfx＜/code＞），从＜code＞c:\ProgramData\chocolatey\中删除了名为＜code＞docfx的每个文件夹。chocolatey\，然后重新安装（choco安装docfx）。之后，一切都恢复正常。文件＜code＞c:\ProgramData\chocolatey\lib\docfx\tools\docfx.exe。config包含大量与msbuild相关的配置。也许那里出了什么事。

Answer 2

由于某些问题，您的VS2017构建工具可能会出现一些问题。最大的问题是：

C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools\Common7\IDE\CommonExtensions\Microsoft\NuGet\Microsoft.Build.NuGetSdkResolver.dll

您丢失了 dll 或 dll 已损坏。

更新

1)首先，您应该检查是否安装了< code > nu get targets and build tasks 工作负载和< code>net core build tools工作负载。如果没有，请安装它。

2）其次，请删除项目的bin和obj文件夹，然后重试。

你应该使用 msbuild -t：restore，build 来构建你的项目。

3)第三，尝试从< code>vs_installer修复您的构建工具。它将修复相关的dll。然后删除< code>bin和< code>obj文件夹，使用构建工具再次html" target="_blank">测试您的项目。

重要：

VS2017不支持net core 3.1。你应该注意。它支持

因此，如果您仍然想将VS2017的构建工具用于您的净核心项目，您应该尝试上述三个步骤，然后将您的项目定位到净核心2.1。

此外，如果您通过CMD启动msBuild，我认为您应该检查您的环境变量PATH，并检查您是否在其上配置了VS2017构建工具中的msbuild.exe。相反，您可以添加C：\节目文件（x86）\Microsoft Visual Studio\2019\Enterprise\MSBuild\当前\MSBuild.exe。这种方式适用于VS2019。

=================================================

更新1

问题是你已经通过choco命令行安装了一个< code>docfx tool。

一开始我一直以为你在项目上用的是docfx.console nuget包，只是从< code>C:\Users\xxx\中调用< code>docfx.exe。命令行下的nu get \ packages \ docfx . console \ 2 . 56 . 5 \ tools \ docfx . exe 。

无论在项目上安装了< code>docfx.console软件包，如果您通过choco命令安装了docfx工具，然后只在命令行上调用< code>docfx.exe，它将使用< code > C:\ program data \ chocolatey \ lib \ docfx \ tools \ docfx . exe 下的本地< code>docfx.exe而不是nuget软件包。

所以问题是您的本地docfx.exe由于一些问题而出现了一些错误。您应该通过choco命令choco卸载docfx重新安装docfx.exe；choco安装docfx。

实际上，直接使用docfx。项目上的控制台nuget包可能更容易。从这个链接。

它已经包含了< code>docfx.exe生成文档的步骤(来自< code>C:\Users\xxx\)。nu get \ packages \ docfx . console \ 2 . 56 . 5 \ tools \ docfx . exe )并将自动执行它，而不是再次手动运行< code>docfx.exe。