NuGet 包 XML 文档在 .NET Core 2.2 应用程序中不可见

Question

我使用的是NuGet package，它有一个XML documentation file。

但是当我将包包含在 .NET Core 2.2 应用程序中时，IntelliSense 无法使用 cmets。

我是否在包或我的应用程序中缺少某些东西才能使用 IntelliSense 查看文档？

使用 VisualStudio 2017、Windows 10。

清晰度更新

NuGet 包是一个 .NET Standard 1.3 类库。在 Visual Studio 中，当我构建项目时，我包含了生成包和文档文件的选项。在项目文件中，我看到了以下 PropertyGroup：

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
    <DocumentationFile>C:\Users\[username]\[local path]\CommonEntities\CommonEntities\CommonEntities.xml</DocumentationFile>
</PropertyGroup>

当我打开包时，我可以在 lib/netstandard1.3/ 目录中看到 CommonEntities.xml 与 MakanalTech.CommonEntities 一起包含。 dll.

但是，我想知道为什么 xml 文件从 MakanalTech.CommonEntities.xml 中删除了全名，因为它在项目中只是 CommonEntities.xml包裹。也许这就是问题的原因？

问题是当我将包作为依赖项包含在另一个项目中时，没有任何 XML cmets/文档可见。因此，我无法将鼠标悬停在某个类型上以查看其描述，并且如果我查看定义，则定义中没有任何 cmets/文档。

类库产品 https://imgur.com/zbE7ngM（还不能发图片）

查看其他项目的定义： https://imgur.com/pwmvpX7

Answer 1

终于从this的帖子中找到了问题。从 Visual Studio 2017 看来，这似乎有很多错误，无法正确和自动处理。

在 .csproj 文件中，我删除了 <DocumentationFile>[filepath-to-xml]</DocumentationFile> 并添加了 <GenerateDocumentationFile>true</GenerateDocumentationFile>。

然后我重新打包了库，清除了我的 nuget 缓存，并在包含它的地方重建了新项目，现在我可以看到所有 XML 文档。

Answer 2

NuGet 包 XML 文档在 .NET Core 2.2 应用中不可见

就像您发现的“在 CommonEntities.xml 与 MakanalTech.CommonEntities.dll 一起包含的 lib/netstandard1.3/ 目录中。”， lib文件夹下的.xml文件，然后根据文件From a convention-based working directory：

只会添加 .dll 文件作为参考，.xml 文件将被复制到项目文件夹中。这就是 XML 文档在 .NET Core 2.2 应用程序中不可见的原因。

此外，由于您使用的是 .netstandard 项目，.xml 文件将被 nuget issue 4837 自动阻止复制到项目文件夹中。

要解决这个问题，我们必须创建带有选项contentFiles 的.nuspec 文件以包含.xml 文件并将此文件添加到项目中，请查看other thread 的详细信息。

但如果您不想在每个版本中手动编辑.nuspec，您可以使用构建后事件自动打包 nuget 包，例如：

nuget pack "$(.NuspecFilePath)\xxx.nuspec" 

或者您可以直接从包中手动将 .xml 文件添加到项目中，该包在路径中：C:\Users\<UserName>\.nuget\packages。

希望这会有所帮助。