源链接是一种技术,可让开发人员从 NuGet 中调试 .NET 程序集。 创建 NuGet 包并将源代码管理元数据嵌入程序集和包中时,将执行源链接。 下载包并且在 Visual Studio 中启用了源链接的开发人员可以单步执行其源代码。 源链接提供源代码管理元数据来创建出色的调试体验。
源链接演示
使用源链接
有关使用源链接的说明,请参阅 dotnet/sourcelink GitHub 存储库。
可以使用 NuGet 包资源管理器 桌面应用或 nuget.info 网站来确认源链接元数据已成功嵌入到包中。 验证 Repository
元数据是否存在并具有注释标识符,以及 .pdb 文件是否与每个目标的 .dll 放置在一起。
✔️ 请考虑使用源链接将源代码管理元数据添加到程序集和 NuGet 包。
小窍门
可以通过向类型添加调试器属性来进一步增强开发人员的调试体验。
- DebuggerDisplayAttribute 可以自定义类或字段在调试器变量窗口中的显示方式。
- DebuggerStepThroughAttribute 指示调试器逐行执行代码,而不是单步执行代码。
- DebuggerBrowsableAttribute 控制成员是否显示在调试器变量窗口中。
✔️ 请考虑发布符号文件(*.pdb
)。
为了获得最佳调试体验,库应发布符号文件并使用源链接。 有关符号文件和符号包的详细信息,请参阅 符号包。
✔️ 请考虑启用确定性生成。
确定性生成使验证生成的二进制文件是从指定的源生成的,并提供可跟踪性。 有关确定性生成及其启用说明的详细信息,请参阅 确定性生成。