使用SourceLink V2调试异步方法是否可行？同步调试正常异步失效

我之前调试内部NuGet包的异步代码时也踩过类似的坑，结合你已经完成的配置，给你几个针对性的排查和解决方向：

• 检查异步方法的编译优化与调试类型设置
  Release模式的编译器优化（哪怕是NuGet包的编译配置）经常会导致异步调试时跳过await行。先确认你的NuGet包项目配置：

  • 打开项目文件（.csproj），确保Debug配置下禁用了优化，并且调试类型设为full（pdbonly会在JIT编译时丢失部分调试信息，影响异步代码调试）：

    <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
      <DebugType>full</DebugType>
      <Optimize>false</Optimize>
    </PropertyGroup>
    

  • 如果是用Release配置打包NuGet包，也要确保显式关闭优化，或者单独为打包配置调试友好的参数。

• 验证SourceLink与源码嵌入的完整性
  你已经用dotnet sourcelink嵌入了源码，不妨再做两步验证：

  • 运行dotnet sourcelink check <你的PDB文件路径>命令，检查PDB的SourceLink配置是否有效，有没有缺失的源码映射记录。
  • 尝试在项目文件中添加<EmbedAllSources>true</EmbedAllSources>，确保所有源码（包括编译器为异步方法生成的状态机代码对应的源码）都嵌入到PDB中，避免SourceLink映射遗漏。

• 检查调试器的异步相关设置
  调试器本身的配置也可能导致无法步入异步方法：

  • 如果用Visual Studio，依次打开工具 -> 选项 -> 调试 -> 常规，确保勾选了启用异步调试，这个选项关闭后，调试器会直接跳过await调用。
  • 暂时关闭启用仅我的代码选项，这个功能可能会让调试器忽略NuGet包里的代码，哪怕你有正确的PDB和源码。

• 确认NuGet符号包的部署情况
  有时候PDB没有和NuGet包一起正确发布：

  • 确保打包时生成了符号包，在项目文件中添加以下配置：

    <PropertyGroup>
      <IncludeSymbols>true</IncludeSymbols>
      <SymbolPackageFormat>snupkg</SymbolPackageFormat>
    </PropertyGroup>
    

  • 调试时打开Visual Studio的模块窗口（调试 -> 窗口 -> 模块），找到你的NuGet包程序集，查看符号状态是否显示为“已加载”，且路径指向正确的PDB文件。

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