调试

你可以在 Visual Studio Code 中使用 Microsoft C# 扩展来调试 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。

Attaching to a process

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

Configuration options

有许多选项和设置可用于配置调试器。你可以使用 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 - 将构建时路径映射到本地源位置。所有构建时路径实例都将被替换为本地源路径。
    示例
      {\"<build-path>\":\"<local-source-path>\"}
• 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。如果热重载开始出现意外行为，建议提高详细程度。

Breakpoints

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

断点 - 条件断点

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

断点 - 函数断点

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

断点 - 日志点

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

要添加日志点，请在代码行旁边的最左侧边距中右键单击。选择 添加日志点 并键入要记录的消息。任何位于花括号（“{”和“}”）之间的表达式都将在命中日志点时进行求值。

日志消息中还支持以下标记

断点 - 触发断点

触发断点是一种在另一个断点命中后自动启用的断点。当代码中出现仅在特定先决条件发生后才出现的故障情况时，它们非常有用。

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

Stopping on exceptions

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

请注意，在 C# 调试器首次调试该文件夹之前，断点 部分将缺少这些条目。

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

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

异常条件

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

示例条件

Expression evaluation

调试器还允许你在 监视 窗口以及调试控制台中评估表达式。

Hot Reload

安装了 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 中使用调试器调试你的项目，无论使用何种语言。