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