发布传统.NET Framework类库符号NuGet包调试问题求助

一、正确配置传统项目生成snupkg并启用SourceLink #

传统非SDK风格的.NET Framework项目需手动添加以下配置到.csproj文件，确保生成带SourceLink信息的snupkg：

<PropertyGroup>
  <!-- 指定符号包格式为snupkg -->
  <SymbolPackageFormat>snupkg</SymbolPackageFormat>
  <!-- 启用SourceLink核心配置 -->
  <PublishRepositoryUrl>true</PublishRepositoryUrl>
  <EmbedUntrackedSources>true</EmbedUntrackedSources>
  <!-- 替换为你的Git仓库SourceLink模板，示例为GitHub格式 -->
  <SourceLinkUrl>https://raw.githubusercontent.com/[用户名]/[仓库名]/$(CommitHash)/{file}</SourceLinkUrl>
  <!-- 设置调试类型为portable，确保pdb包含SourceLink元数据 -->
  <DebugType>portable</DebugType>
  <DebugSymbols>true</DebugSymbols>
</PropertyGroup>

<!-- 引入对应Git平台的SourceLink包，以GitHub为例 -->
<ItemGroup>
  <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All" />
</ItemGroup>

注意：需确保项目已关联远程Git仓库，否则SourceLink无法生成有效的源码链接。

二、生成并发布符号包的正确步骤 #

1. 清理并构建目标版本（建议用Release）：

msbuild /t:Clean,Build /p:Configuration=Release

2. 生成普通包和snupkg符号包：

nuget pack -Symbols -SymbolPackageFormat snupkg -OutputDirectory "..\artifacts" -Version 1.0.0

3. 分别推送两个包到NuGet.org：

nuget push "..\artifacts\PackageName.1.0.0.nupkg" -Source https://api.nuget.org/v3/index.json -ApiKey 你的API密钥
nuget push "..\artifacts\PackageName.1.0.0.snupkg" -Source https://api.nuget.org/v3/index.json -ApiKey 你的API密钥

三、调试时解决「Source Not found」的关键设置 #

在Visual Studio中配置以下选项，实现自动加载符号和源码：

• 打开工具 > 选项 > 调试 > 符号，添加符号服务器：https://symbols.nuget.org/download/symbols，勾选「自动加载所有符号」（或指定你的包的dll）
• 打开工具 > 选项 > 调试 > 常规，勾选：
  • 启用源链接支持
  • 取消勾选「要求源文件与原始版本完全匹配」（避免本地源码版本不一致导致加载失败）

四、关于NuGet包选择的疑问 #

不需要发布两个不同命名的包。用户只需引用普通的.nupkg，Visual Studio会自动关联并下载对应的符号包，通过SourceLink从Git仓库拉取源码，无需手动选择符号包。

针对你的更新内容补充 #

• UPDATE：生成snupkg仍找不到源码，大概率是SourceLink配置未生效或VS调试设置未开启。检查项目文件中的SourceLinkUrl是否正确、是否引入了对应SourceLink包，同时确认VS的源链接和符号选项已启用。
• UPDATE2：本地添加源码路径是临时方案，本质绕开了SourceLink自动加载机制，正确做法是通过SourceLink让VS自动从远程仓库获取源码，无需本地检出。
• UPDATE3：仅设置<DebugType>embedded</DebugType>不够，需配合<EmbedAllSources>true</EmbedAllSources>和完整的SourceLink配置。可使用dotnet sourcelink test命令（需安装dotnet-sourcelink工具）验证pdb是否包含有效SourceLink信息。

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