在Visual Studio 2019中使用新项目文件格式及Pack命令，如何将.pdb文件包含进NuGet包并确保安装时复制到输出目录？

Great question! Let's break this into two straightforward steps: getting your .pdb files into the NuGet package, and making sure they automatically copy to the output directory when the package is installed in another project. Here's exactly how to do it with Visual Studio 2019 and the modern SDK project format:

Step 1: Include .pdb Files in Your NuGet Package #

By default, NuGet separates debug symbols into a separate .symbols.nupkg file when you run dotnet pack. To include the .pdb directly in your main package (so consumers don't need to download a separate symbols package), use one of these methods:

Option 1: Use Built-In Properties (Simplest Approach) #

Add these properties to a <PropertyGroup> block in your .csproj file:

<PropertyGroup>
  <!-- Generate portable PDBs (recommended for cross-platform compatibility and smaller size) -->
  <DebugType>portable</DebugType>
  <DebugSymbols>true</DebugSymbols>
  
  <!-- Include symbols (PDBs) in the main NuGet package instead of a separate symbols package -->
  <IncludeSymbolsInPackage>true</IncludeSymbolsInPackage>
</PropertyGroup>

This tells the build system to generate portable PDBs and bundle them right alongside your DLL in the package's lib folder.

Option 2: Explicitly Allow PDBs in Build Output #

If you prefer more control, you can add .pdb to the list of allowed file extensions that get included when packing build outputs:

<PropertyGroup>
  <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
</PropertyGroup>

This ensures the .pdb file generated during build is included in the package.

Step 2: Ensure PDBs Are Copied to the Consuming Project's Output #

In most cases, if your .pdb is in the same lib folder as the DLL, Visual Studio will automatically copy it to the consuming project's output directory when building. But to guarantee this behavior (or fix cases where it's not working), explicitly set copy metadata for the PDB in your source project:

Add this <ItemGroup> to your .csproj:

<ItemGroup>
  <!-- Mark the PDB to be packed and copied to output when the package is installed -->
  <Content Include="$(OutputPath)\$(AssemblyName).pdb" Pack="true" PackagePath="lib\$(TargetFramework)">
    <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
    <PrivateAssets>all</PrivateAssets>
  </Content>
</ItemGroup>

• Pack="true": Ensures the PDB is included in the NuGet package.
• PackagePath: Places the PDB in the correct lib subfolder matching your target framework (e.g., lib/net5.0).
• CopyToOutputDirectory>PreserveNewest: Tells the consuming project to copy the PDB to its output folder, only if it's newer than the existing file.
• PrivateAssets>all: Prevents the PDB from being treated as a dependency for projects that reference your consuming project.

Testing It Out #

After updating your .csproj, run the Pack command in Visual Studio (right-click the project → Pack) or use dotnet pack in the terminal. Install the generated .nupkg in a test project, build it, and check the bin/Debug (or Release) folder—you should see your DLL and matching .pdb file there.

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