c# - 启用 SourceLink

Question

在 VSTS (Azure DevOps) 上拥有私有(private)存储库我尝试通过将以下内容添加到 .csproj 文件来启用 SourceLink:https://github.com/dotnet/sourcelink#azure-devops-visual-studio-team-services

这在调试过程中似乎没有任何影响。本地 NuGet 包中引发异常，我无法使用调用堆栈窗口导航到它，因为甚至没有为该项目加载 pdb。

我在 Visual Studio 中禁用了“仅启用我的代码”并启用了 SourceLink。

我还需要进行哪些其他更改才能启用 SourceLink？

Answer 1

大多数关于如何设置 SourceLink 的教程似乎都忽略了两个关键内容。

首先:

• 除了取消选中“仅启用我的代码”(非默认)并确保在选项/调试/常规下选中“启用源链接支持”(默认)，
• 如果您想使用 SourceLink 处理公共(public)包(比如 Newtonsoft.Json)，您还必须检查 VS Options/Debugging/Symbols 中列出的符号服务器。

其次:

• 如果您想将自己的包的符号发布到公共(public)提要(例如 nuget.org)上，那么 AFAIK .snupkg 格式可以正常工作
• 在私有(private) NuGet 源(无论是使用本地文件系统 NuGet 源还是 IIS NuGet.Server 包)上没有符号服务器，.snupkg 不是支持，并且这(被广泛列为要做什么)不起作用(它包括 NuGet 包中的 .pdb 文件，但从我的测试来看，消费 VS 从不使用它们):

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

• 在同一个地方使用它确实可以工作(pdb 嵌入在 dll 本身中，消费 VS 可以很好地看到它):

  <PropertyGroup>
    <DebugType>Embedded</DebugType>
  </PropertyGroup>

您绝对应该查看 Debug/Windows/Modules 下的 VS Modules 窗口(快捷键 CTRL+ALT+U)(仅在代码运行时可用)，它显示了哪些模块已加载符号并帮助您找出哪个避风港'不，如果他们没有，为什么不呢。

编辑

事实证明:

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

正在工作。它会生成一个很好的 NuGet 文件，或者应该......但目前有 a bug in .NET SDK这导致它不会以这种方式加载存储在 NuGet 文件中的 .pdb 文件，尽管它应该这样做。

还有另一个修复。在消费项目中，包括:

    <PackageReference Include="SourceLink.Copy.PdbFiles" Version="2.8.3" PrivateAssets="All" />

添加后，一切都应该按照演示再次运行。

或者，该包应用的修复是:

<Project>
  <Target Name="_ResolveCopyLocalNuGetPackagePdbs" AfterTargets="ResolveReferences"
      Condition="$(CopyLocalLockFileAssemblies) == true">
    <ItemGroup>
      <ReferenceCopyLocalPaths Include="@(ReferenceCopyLocalPaths->'%(RootDir)%(Directory)%(Filename).pdb')" 
          Condition="'%(ReferenceCopyLocalPaths.NuGetPackageId)' != '' and Exists('%(RootDir)%(Directory)%(Filename).pdb')" />
    </ItemGroup>
  </Target>
</Project>

和(来自 here):

A good place to put it is in Directory.Build.targets so that your project files are not cluttered and so that you can apply it to multiple projects in a solution. https://learn.microsoft.com/en-us/visualstudio/msbuild/customize-your-build