使用 Visual Studio Code 调试代码

Visual Studio Code 提供了对各种应用程序进行调试的丰富支持。VS Code 内置了对 JavaScript、TypeScript 和 Node.js 调试的支持。Visual Studio Marketplace 提供了各种调试扩展，可为 VS Code 添加对其他语言和运行时的调试支持。

本文介绍了 VS Code 的调试功能，以及如何开始在 VS Code 中进行调试。您还将学习如何使用 VS Code 中的 Copilot 来加速调试配置的设置和调试会话的启动。

以下视频演示了如何在 VS Code 中开始调试。

调试器用户界面

下图显示了调试器用户界面的主要组件

1. 运行和调试视图：显示与运行、调试和管理调试配置设置相关的所有信息。
2. 调试工具栏：包含最常用的调试操作按钮。
3. 调试控制台：允许查看和交互调试器中运行的代码的输出。
4. 调试侧边栏：在调试会话期间，允许您与调用堆栈、断点、变量和监视变量进行交互。
5. 运行菜单：包含最常用的运行和调试命令。

开始调试之前

1. 从 Visual Studio Marketplace 为您的语言或运行时安装调试扩展。

   VS Code 内置了对 JavaScript、TypeScript 和 Node.js 调试的支持。

2. 为您的项目定义调试配置。

   对于简单的应用程序，VS Code 尝试运行和调试当前活动文件。对于更复杂的应用程序或调试场景，您需要创建一个 launch.json 文件来指定调试器配置。获取有关创建调试配置的更多信息。

   提示

   VS Code 中的 Copilot 可以帮助您生成 launch.json 文件。有关更多信息，请参阅使用 Copilot 生成调试配置。

3. 在您的代码中设置断点。

   断点是一个标记，您可以将其设置在代码行上，以告知调试器在该行到达时暂停执行。您可以通过单击编辑器中行号旁边的装订线来设置断点。

   有关断点的更多信息，请参阅使用断点。

启动调试会话

要在 VS Code 中启动调试会话，请执行以下步骤

1. 打开包含您要调试的代码的文件。

2. 使用 F5 键启动调试会话，或在运行和调试视图 (workbench.view.debug) 中选择运行和调试。

   

   对于更复杂的调试场景（例如附加到正在运行的进程），您需要创建一个 launch.json 文件来指定调试器配置。获取有关调试配置的更多信息。

3. 从可用调试器列表中选择您要使用的调试器。

   VS Code 尝试运行和调试当前活动文件。对于 Node.js，VS Code 检查 package.json 文件中是否有 start 脚本，以确定应用程序的入口点。

4. 当调试会话开始时，将显示 调试控制台 面板并显示调试输出，并且状态栏的颜色会更改（对于默认颜色主题为橙色）。

   

5. 状态栏中的调试状态显示活动调试配置。选择调试状态以更改活动启动配置并开始调试，而无需打开运行和调试视图。

   

调试操作

调试会话开始后，调试工具栏将出现在窗口顶部。工具栏包含用于控制调试会话流程的操作，例如单步执行代码、暂停执行和停止调试会话。

下表描述了调试工具栏中可用的操作

如果您的调试会话涉及多个目标（例如，客户端和服务器），则调试工具栏会显示会话列表，并允许您在它们之间切换。

断点

断点是一个特殊标记，它会在特定点暂停代码的执行，以便您可以检查应用程序在该点的状态。VS Code 支持多种类型的断点。

设置断点

要设置或取消设置断点，请单击编辑器边距或在当前行使用 F9。

• 编辑器边距中的断点通常显示为红色实心圆圈。
• 禁用的断点具有灰色实心圆圈。
• 当调试会话开始时，无法向调试器注册的断点会更改为灰色空心圆圈。如果在没有实时编辑支持的情况下运行调试会话时编辑了源，则也可能发生同样的情况。

（可选）可以通过启用 debug.showBreakpointsInOverviewRuler 设置，在编辑器的概览标尺中显示断点

要更精细地控制断点，请使用运行和调试视图的断点部分。此部分列出了代码中的所有断点，并提供了管理它们的额外操作。

断点类型

条件断点

VS Code 强大的调试功能是能够根据表达式、命中计数或两者的组合设置条件。

• 表达式条件：每当表达式评估为 true 时，就会命中断点。
• 命中计数：命中计数控制断点需要被命中多少次才能中断执行。命中计数是否被遵守以及表达式的确切语法可能因调试器扩展而异。
• 等待断点：当命中另一个断点（触发断点）时，断点被激活。

要添加条件断点

1. 创建条件断点

   • 在编辑器边距中单击鼠标右键，然后选择添加条件断点。
   • 使用命令面板中的添加条件断点命令 (⇧⌘P (Windows, Linux Ctrl+Shift+P))。

2. 选择要设置的条件类型（表达式、命中计数或等待断点）。

   

要为现有断点添加条件

1. 编辑现有断点

   • 在编辑器边距中的断点上单击鼠标右键，然后选择编辑断点。
   • 在运行和调试视图的断点部分中，选择现有断点旁边的铅笔图标。

2. 编辑条件（表达式、命中计数或等待断点）。

如果调试器不支持条件断点，则添加条件断点和编辑条件操作不可用。

触发断点

触发断点是一种条件断点，它在命中另一个断点后启用。当诊断仅在某个前提条件之后才发生的代码中的故障情况时，它们可能很有用。

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

内联断点

仅当执行到达与内联断点关联的列时，才会命中内联断点。这在调试缩小的代码时很有用，这些代码在一行中包含多个语句。

可以使用 ⇧F9 (Windows, Linux Shift+F9) 或在调试会话期间通过上下文菜单来设置内联断点。内联断点在编辑器中内联显示。

内联断点也可以有条件。可以通过编辑器左边距中的上下文菜单编辑一行上的多个断点。

函数断点

调试器可以支持通过指定函数名称来创建断点，而不是直接将断点放置在源代码中。这在源代码不可用但函数名称已知的情况下很有用。

要创建函数断点，请选择断点部分标题中的 + 按钮，然后输入函数名称。函数断点在断点部分中以红色三角形显示。

数据断点

如果调试器支持数据断点，则可以从变量视图中的上下文菜单设置它们。在值更改/读取/访问时中断命令添加一个数据断点，当基础变量的值更改/被读取/被访问时，将命中该断点。数据断点在断点部分中以红色六边形显示。

日志点

日志点是断点的一种变体，它不会中断到调试器中，而是将消息记录到调试控制台。日志点可以通过不必在代码中添加或删除日志语句来帮助您节省时间。

日志点由菱形图标表示。日志消息是纯文本，但也可以包含要在花括号 ('{}') 中评估的表达式。

要添加日志点，请在编辑器左边距中单击鼠标右键，然后选择添加日志点，或使用命令面板中的调试：添加日志点... 命令 (⇧⌘P (Windows, Linux Ctrl+Shift+P))。您还可以配置 debug.gutterMiddleClickAction 设置，以便在编辑器装订线中按鼠标中键时切换日志点。

与常规断点一样，日志点可以启用或禁用，也可以通过条件和/或命中计数进行控制。

数据检查

运行和调试视图

在调试会话期间，您可以在运行和调试视图的变量部分中检查变量和表达式，或通过将鼠标悬停在编辑器中的源代码上来检查它们。变量值和表达式求值相对于调用堆栈部分中选定的堆栈帧。

要在调试会话期间更改变量的值，请在变量部分中的变量上单击鼠标右键，然后选择设置值 (Enter (Windows, Linux F2))。

此外，您可以使用复制值操作来复制变量的值，或使用复制为表达式操作来复制用于访问变量的表达式。然后，您可以在监视部分中使用此表达式。

变量和表达式也可以在运行和调试视图的监视部分中进行评估和监视。

要按名称或值筛选变量，请在焦点位于变量部分时使用 ⌥⌘F (Windows, Linux Ctrl+Alt+F) 键盘快捷键，然后键入搜索词。

调试控制台 REPL

可以使用 调试控制台 REPL (读取-求值-打印循环) 功能评估表达式。要打开调试控制台，请使用调试窗格顶部的调试控制台操作，或使用视图：调试控制台命令 (⇧⌘Y (Windows, Linux Ctrl+Shift+Y))。

按下 Enter 后，将评估表达式，并且调试控制台 REPL 会在您键入时显示建议。如果您需要输入多行，请在行之间使用 Shift+Enter，然后使用 Enter 发送所有行以进行评估。

调试控制台输入使用活动编辑器的模式，这意味着调试控制台输入支持语法着色、缩进、自动关闭引号和其他语言功能。

多目标调试

对于涉及多个进程（例如，客户端和服务器）的复杂场景，VS Code 支持多目标调试。在启动第一个调试会话后，您可以启动另一个调试会话。一旦第二个会话启动并运行，VS Code UI 就会切换到多目标模式

• 各个会话现在在调用堆栈视图中显示为顶层元素。

  

• 调试工具栏显示当前活动会话（所有其他会话都可在下拉菜单中找到）。

  

• 调试操作（例如，调试工具栏中的所有操作）在活动会话上执行。可以通过使用调试工具栏中的下拉菜单或通过在调用堆栈视图中选择不同的元素来更改活动会话。

远程调试

VS Code 不支持跨所有语言的内置远程调试。远程调试是您正在使用的调试扩展的功能，您应该查阅 Marketplace 中的扩展页面以获取支持和详细信息。

但是，有一个例外：VS Code 中包含的 Node.js 调试器支持远程调试。有关更多信息，请参阅Node.js 调试。

调试器扩展

VS Code 内置了对 Node.js 运行时的调试支持，并且可以调试 JavaScript、TypeScript 或任何其他转译为 JavaScript 的语言。

对于调试其他语言和运行时（包括 PHP、Ruby、Go、C#、Python、C++、PowerShell 和 许多其他语言），请在 Visual Studio Marketplace 中查找 Debuggers 扩展，或在顶层“运行”菜单中选择安装其他调试器。

以下是一些包含调试支持的常用扩展

后续步骤

要了解有关 VS Code 的 Node.js 调试支持，请查看

• Node.js - 描述了 VS Code 中包含的 Node.js 调试器。
• TypeScript - Node.js 调试器也支持 TypeScript 调试。

要观看有关调试基础知识的教程，请查看此视频

• VS Code 调试入门 - 了解 VS Code 中的调试。

要了解有关 Copilot 和 VS Code 中 AI 辅助调试的更多信息

• 使用 Copilot 调试和修复问题
• Copilot 调试和修复问题速查表

要了解有关通过 VS Code 扩展对其他编程语言的调试支持

• C++
• Python
• Java

要了解有关 VS Code 的任务运行支持，请转到

• 任务 - 描述如何使用 Gulp、Grunt 和 Jake 运行任务，以及如何显示错误和警告。

要编写您自己的调试器扩展，请访问

• 调试器扩展 - 使用模拟示例来说明创建 VS Code 调试扩展所需的步骤。

常见问题

支持哪些调试场景？

Node.js 应用程序的调试在 Linux、macOS 和 Windows 上开箱即用地通过 VS Code 支持。Marketplace 中提供的 VS Code 扩展 支持许多其他场景。