调试

您可以使用 Microsoft C# 扩展在 Visual Studio Code 中调试 C# 应用程序。

运行和调试

C# 扩展以及 C# Dev Kit 提供了多种方式来运行和调试 C# 应用程序。

若要在不使用 C# Dev Kit 的情况下运行和调试，请参阅Microsoft C# 扩展的 GitHub 页面以获取文档。

使用 F5 键进行调试

安装了 C# Dev Kit 扩展并且在“运行和调试”视图中没有可供选择的调试配置时，可以通过打开一个 .cs 文件然后按 F5 来开始调试项目。调试器将自动找到您的项目并开始调试。如果您有多个项目，它会提示您选择要开始调试的项目。

您也可以从 VS Code 侧边栏的运行和调试视图开始调试会话。有关更多信息，请参阅在 VS Code 中进行调试。

使用解决方案资源管理器进行调试

安装了 C# Dev Kit 扩展后，在解决方案资源管理器中右键单击您的项目时，会有一个调试上下文菜单。

有三个选项

• 启动新实例 - 这将启动您的项目并附加调试器。
• 不进行调试启动 - 这将在不附加调试器的情况下运行您的项目。
• 单步进入新实例 - 这将启动您的项目并附加调试器，但在代码入口处停止。

使用命令面板进行调试

安装了 C# Dev Kit 扩展后，您还可以通过使用调试: 选择并启动调试命令，从命令面板 ⇧⌘P (Windows, Linux Ctrl+Shift+P) 开始调试。

注意: 这会将一个启动配置条目添加到您的调试下拉列表中。

使用动态（内存中）启动配置进行调试

安装了 C# Dev Kit 扩展后，您可以创建动态启动配置。创建方式取决于您的项目是否包含现有的 launch.json 文件。

现有 launch.json

如果您有一个现有的 launch.json 文件，您可以转到“调试”视图，选择下拉菜单，然后选择 C# 选项。这将为您提供一系列可以添加到下拉列表中的启动目标。选择后，您可以按 F5 或使用新生成的配置选择启动调试。

没有 launch.json 文件

如果您的项目中没有 launch.json 文件，您可以在“调试”视图的显示所有自动调试配置中添加并访问这些动态配置。

移除动态（内存中）启动配置

您可以使用命令面板 ⇧⌘P (Windows, Linux Ctrl+Shift+P) 并使用调试: 选择并启动调试命令移除生成的配置。

在下拉菜单中，列出了所有现有的调试配置。将鼠标悬停在动态配置上时，右侧会出现一个可点击的垃圾桶图标。您可以选择该图标以移除动态配置。

使用编辑器调试/运行按钮进行调试

在编辑器中打开 .cs 文件时，可以通过编辑器窗口右上角的按钮访问运行和调试选项。这些操作将使用当前文件来查询项目系统并确定要启动的关联项目。

这两个选项是

• 运行与此文件关联的项目: 这将使用调试适配器以 noDebug: true 方式启动您的程序。
• 调试与此文件关联的项目: 这将在调试器下启动您的程序。

使用 launch.json 进行调试

如果您使用的是 C# Dev Kit，我们建议不要使用此选项。但是，如果您需要直接修改调试配置，请参阅配置 C# 调试的 launch.json。

附加到进程

您可以使用命令面板 ⇧⌘P (Windows, Linux Ctrl+Shift+P) 并运行调试: 附加到 .NET 5+ 或 .NET Core 进程命令来附加到 C# 进程。

配置选项

有许多可用选项和设置来配置调试器。您可以使用 launchSettings.json、VS Code 用户设置来修改您的调试选项，或者直接修改您的 launch.json 文件。

launchSettings.json

如果您有来自 Visual Studio 的 launchSettings.json 文件，您应该会看到使用 从 F5 运行 或 从命令面板运行 列出的配置文件。

有关更多详细信息，请参阅配置 C# 调试。

用户设置

如果您在使用 C# 调试器时希望更改设置，可以在 文件 > 首选项 > 设置 (⌘, (Windows, Linux Ctrl+,)) 下找到这些选项并进行搜索。

• csharp.debug.stopAtEntry - 如果为 true，调试器应在目标程序的入口点停止。此选项默认为 false。
• csharp.debug.console - 在启动控制台项目时，指示目标程序应在哪个控制台中启动。注意: 此选项仅用于 'dotnet' 调试配置类型。
  • internalConsole [默认] - VS Code 的调试控制台。此模式允许您在一个地方查看来自调试器和目标程序的消息。有关更多详细信息，请参阅完整文档。
  • integratedTerminal - VS Code 的集成终端。
  • externalTerminal - 可通过用户设置配置的外部终端。
• csharp.debug.sourceFileMap - 将构建时路径映射到本地源代码位置。构建时路径的所有实例都将替换为本地源代码路径。
    示例
      {"<构建时路径>":"<本地源路径>"}
• csharp.debug.justMyCode - 启用时（默认设置），调试器仅显示并单步进入用户代码（“我的代码”），忽略系统代码以及已优化或没有调试符号的其他代码。更多信息。
• csharp.debug.requireExactSource - 标志，要求当前源代码与 pdb 匹配。此选项默认为 true。
• csharp.debug.enableStepFiltering - 标志，用于启用跳过属性和运算符。此选项默认为 true。
• csharp.debug.logging.exceptions - 标志，用于确定是否应将异常消息记录到输出窗口。此选项默认为 true。
• csharp.debug.logging.moduleLoad - 标志，用于确定是否应将模块加载事件记录到输出窗口。此选项默认为 true。
• csharp.debug.logging.programOutput - 标志，用于确定在不使用外部控制台时是否应将程序输出记录到输出窗口。此选项默认为 true。
• csharp.debug.logging.diagnosticsLog - 用于诊断调试器问题的各种设置。
• csharp.debug.logging.browserStdOut - 标志，用于确定是否应将启动 Web 浏览器产生的标准输出文本记录到输出窗口。此选项默认为 true。
• csharp.debug.logging.elapsedTiming - 如果为 true，引擎日志包含 adapterElapsedTime 和 engineElapsedTime 属性，以微秒为单位指示请求花费的时间。此选项默认为 false。
• csharp.debug.logging.threadExit - 控制目标进程中的线程退出时是否记录消息。此选项默认为 false。
• csharp.debug.logging.processExit - 控制目标进程退出或调试停止时是否记录消息。此选项默认为 true。
• csharp.debug.suppressJITOptimizations - 如果为 true，当目标进程加载优化模块（以 Release 配置编译的 .dll）时，调试器会要求即时编译器生成禁用优化后的代码。更多信息
• csharp.debug.symbolOptions.searchPaths - 符号服务器 URL（例如: http://MyExampleSymbolServer）或目录（例如: /build/symbols）的数组，用于搜索 .pdb 文件。除了模块旁边的默认位置和 pdb 最初放置的路径之外，还将搜索这些目录。
• csharp.debug.symbolOptions.searchMicrosoftSymbolServer - 如果为 true，则将 Microsoft 符号服务器（https://msdl.microsoft.com/download/symbols）添加到符号搜索路径中。如果未指定，此选项默认为 false。
• csharp.debug.symbolOptions.searchNuGetOrgSymbolServer - 如果为 true，则将 NuGet.org 符号服务器（https://symbols.nuget.org/download/symbols）添加到符号搜索路径中。如果未指定，此选项默认为 false。
• csharp.debug.symbolOptions.cachePath - 从符号服务器下载的符号应缓存到的目录。如果未指定，在 Windows 上，调试器默认为 %TEMP%\\SymbolCache；在 Linux 和 macOS 上，调试器默认为 ~/.dotnet/symbolcache。
• csharp.debug.symbolOptions.moduleFilter.mode - 控制模块过滤器工作的两种基本模式。
  • loadAllButExcluded - 加载所有模块的符号，除非模块在 excludedModules 数组中。
  • loadOnlyIncluded - 不尝试加载任何模块的符号，除非它在 includedModules 数组中，或者通过 includeSymbolsNextToModules 设置包含。
• csharp.debug.symbolOptions.moduleFilter.excludedModules - 调试器不应加载符号的模块数组。支持通配符（例如: MyCompany.*.dll）。除非将 mode 设置为 loadAllButExcluded，否则此属性将被忽略。
• csharp.debug.symbolOptions.moduleFilter.includedModules - 调试器应加载符号的模块数组。支持通配符（例如: MyCompany.*.dll）。除非将 mode 设置为 loadOnlyIncluded，否则此属性将被忽略。
• csharp.debug.symbolOptions.moduleFilter.includeSymbolsNextToModules - 如果为 true，对于不在 includedModules 数组中的任何模块，调试器仍将检查模块本身和启动的可执行文件旁边，但不会检查符号搜索列表中的路径。此选项默认为 true。除非将 mode 设置为 loadOnlyIncluded，否则此属性将被忽略。
• csharp.debug.allowFastEvaluate - 当为 true（默认状态）时，调试器将尝试通过模拟简单属性和方法的执行来实现更快的求值。
• csharp.experimental.debug.hotReload - 当为 true 时，如果目标应用程序支持热重载，调试器将启用在调试时应用更改。
• csharp.debug.hotReloadOnSave - 当为 true（默认状态）时，调试器将在保存文件时自动应用代码更改。
• csharp.debug.hotReloadVerbosity - 控制C# 热重载输出窗口的日志详细程度。可以设置为 minimal（默认）、detailed 或 diagnostic。如果热重载开始出现意外行为，建议提高详细程度级别。

断点

C# 调试器支持各种断点，例如源代码行断点、条件断点和日志点。

断点 - 条件断点

借助表达式求值，调试器还支持条件断点。您可以设置断点在表达式求值为 true 时中断。

断点 - 函数断点

调试器还支持函数断点。您可以通过单击“调试”窗格“断点”部分中的 + 来设置断点以在特定函数处中断。

断点 - 日志点

日志点（在 Visual Studio 中也称为跟踪点）允许您将输出发送到调试控制台，而无需编辑代码。它们与断点不同，因为它们不会停止应用程序的执行流。

要添加日志点，请在代码行左侧的空白处右键单击。选择添加日志点并输入要记录的消息。日志点被命中时，大括号（'{' 和 '}'）之间的任何表达式都将被求值。

日志消息中还支持以下令牌

断点 - 触发断点

触发断点是一种断点，一旦命中另一个断点，它就会自动启用。在诊断仅在满足特定前置条件后发生的代码故障时，它们非常有用。

可以通过右键单击字形边距，选择添加触发断点，然后选择启用该断点的其他断点来设置触发断点。

在异常处停止

C# 调试器支持配置何时在抛出或捕获异常时停止调试器。这是通过“运行”视图的断点部分中的两个不同条目完成的。

请注意，直到第一次使用 C# 调试器调试该文件夹之前，“断点”部分将缺少这些条目。

勾选所有异常将配置调试器在抛出异常时停止。如果启用了仅我的代码（默认已启用），则如果异常在库代码中内部抛出并捕获，调试器将不会中断。但是，如果异常在库代码中抛出并返回给用户代码，调试器将中断。

勾选用户未处理的异常将配置调试器在异常在用户代码中抛出或通过用户代码传播后，在非用户代码中被捕获时停止。成为用户未处理的异常并不总是被调试进程中的错误 -- 可能是用户代码正在实现 API，并且期望抛出异常。在许多情况下，确实存在实际问题，因此，默认情况下，当异常成为用户未处理时，调试器将停止。

异常条件

这两个复选框都支持仅在选定的异常类型上中断的条件。要编辑条件，请选择铅笔图标（参见上图）或右键单击条目并调用编辑条件。条件是一个逗号分隔的异常类型列表，用于中断，如果列表以 '!' 开头，则表示要忽略的异常类型列表。

示例条件

表达式求值

调试器还允许您在监视窗口以及调试控制台中求值表达式。

热重载

安装了 C# Dev Kit 扩展后，调试器允许您在调试时应用 C# 代码更改。

要启用热重载，必须将 csharp.experimental.debug.hotReload 设置为 true，有关更多信息，请参阅用户设置。热重载会话仅在目标调试器引擎支持应用代码更改时才会启动。

支持的项目和场景

C# Dev Kit 支持“经典”的热重载体验，也称为编辑并继续。无论您是停在断点处还是程序正在运行，都可以在调试时应用代码更改。

截至 2023 年 11 月，某些功能（例如 MetadataUpdateHandler，它允许 ASP.NET Core 应用程序在进行更改后自动刷新浏览器）尚不可用。在不进行调试的情况下应用代码更改也不受支持。

运行时在 .NET 8 中添加了对在 Linux/macOS 上调试时应用更改的支持，因此在为运行在这些操作系统上的 .NET 应用应用代码更改时，需要 .NET 8+ 的运行时版本。

有关 C# Dev Kit 当前支持的项目的更多信息，请参阅支持的项目。有关其他不受支持场景的故障排除信息，另请参阅C# Dev Kit 常见问题解答。

如何应用代码更改

热重载会话启动并进行新更改后，您可以通过以下任一操作将这些更改应用到您的应用程序

下一步

继续阅读以了解

• 调试 - 了解如何在 VS Code 中将调试器与您的项目一起用于任何语言。