NuGet包XML文档未在Swagger中显示的问题排查求助

• 确保类库打包时正确包含XML并设置复制属性
  在类库项目的.csproj文件中，除了已有的<GenerateDocumentationFile>true</GenerateDocumentationFile>，补充以下配置，保证XML文件被打包到NuGet包的对应目录，并且引用时会自动复制到输出目录：

  <PropertyGroup>
    <GenerateDocumentationFile>true</GenerateDocumentationFile>
    <!-- 可选：包含符号文件，强化XML与DLL的关联 -->
    <IncludeSymbols>true</IncludeSymbols>
    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
  </PropertyGroup>
  
  <ItemGroup>
    <!-- 明确将生成的XML文件纳入NuGet包，并设置复制规则 -->
    <None Include="$(OutputPath)$(AssemblyName).xml" 
          Pack="true" 
          PackagePath="lib\$(TargetFramework)" 
          CopyToOutputDirectory="PreserveNewest" />
  </ItemGroup>
  

  重新打包发布NuGet包后，在API项目中更新该包引用。

• 在API项目中手动添加复制XML的MSBuild目标
  若不想重新打包类库，可直接在API项目的.csproj中添加自定义目标，自动复制NuGet包中的XML文件到输出目录：

  <Target Name="CopyNuGetXmlDocs" AfterTargets="Build">
    <ItemGroup>
      <!-- 匹配NuGet包中的XML文件路径，替换MyModels为你的包名 -->
      <NuGetXmlFiles Include="$(SolutionDir)packages\MyModels.*\lib\net6.0\MyModels.xml" />
    </ItemGroup>
    <Copy SourceFiles="@(NuGetXmlFiles)" 
          DestinationFolder="$(OutputPath)" 
          SkipUnchangedFiles="true" />
  </Target>
  

• 检查手动编写的nuspec配置（若使用）
  如果你是通过手动.nuspec文件打包，确认<files>节点中包含XML文件的配置：

  <files>
    <file src="bin\Release\net6.0\MyModels.dll" target="lib\net6.0" />
    <file src="bin\Release\net6.0\MyModels.xml" target="lib\net6.0" />
  </files>
  

  确保XML和DLL被打包到同一目录，这样引用时才能被正确识别。

• 验证API项目的包引用属性
  在API项目中右键点击MyModels NuGet包，查看属性，确认复制本地选项设置为True（NuGet包默认开启，但可手动确认）。

内容的提问来源于stack exchange，提问作者mituw16