教程:了解如何使用 Visual Studio 调试 C# 代码

本文通过分步演练介绍了 Visual Studio 调试器的功能。 如果需要更加深入地了解调试器功能,请参阅初探调试器。 当你调试应用时,通常意味着运行附带有调试器的应用程序 。 执行此操作时,调试器在运行过程中可提供许多方法让你查看代码的情况。 你可以逐步浏览代码、查看变量中存储的值、设置对变量的监视以查看值何时改变、检查代码的执行路径、查看代码分支是否正在运行等等。 如果这是你第一次尝试调试代码,可能需要在浏览本文之前阅读零基础调试

虽然演示应用为 C#,但大多数功能都适用于 C++、Visual Basic、F#、Python、JavaScript 和 Visual Studio 支持的其他语言(F# 不支持“编辑并继续”。 F# 和 JavaScript 不支持“自动”窗口 )。 屏幕截图为 C#。

在本教程中,你将:

  • 启动调试器并命中断点。
  • 了解在调试器中逐步执行代码的命令
  • 检查数据提示和调试器窗口中的变量
  • 检查调用堆栈

先决条件

必须安装 Visual Studio 2019 且具有“.NET Core 跨平台开发”工作负载 。

必须安装 Visual Studio 2017 且具有“.NET Core 跨平台开发”工作负载 。

如果尚未安装 Visual Studio,请转到 Visual Studio 下载页免费安装。

如果尚未安装 Visual Studio,请转到 Visual Studio 下载页免费安装。

如果尚未安装 Visual Studio 2022 预览版,请转到 Visual Studio 2022 预览版下载页免费安装。

如果需要安装工作负载但已有 Visual Studio,请转到“工具” > “获取工具和功能...” ,这会打开 Visual Studio 安装程序。 Visual Studio 安装程序启动。 选择“.NET Core 跨平台开发”工作负载,然后选择“修改” 。

创建项目

首先,创建一个 .NET Core 控制台应用程序项目。 项目类型随附了所需的全部模板文件,无需添加任何内容!

  1. 打开 Visual Studio 2017。

  2. 从顶部菜单栏中选择“文件”>“新建”>“项目” 。

  3. 在“新建项目” 对话框的左窗格中,展开“C#” ,然后选择“.NET Core” 。 在中间窗格中,选择“控制台应用(.NET Core)” 。 然后将项目命名为 get-started-debugging 。

    如果看不到“控制台应用(.NET Core)” 项目模板,请选择“新建项目” 对话框左侧窗格中的“打开 Visual Studio 安装程序” 链接。

    Visual Studio 安装程序启动。 选择“.NET Core 跨平台开发”工作负载,然后选择“修改” 。

  1. 打开 Visual Studio。

    如果开始窗口未打开,请选择“文件”>“开始窗口” 。

  2. 在“开始”窗口上,选择“创建新项目” 。

  3. 在“创建新项目”窗口的搜索框中输入或键入“控制台” 。 接下来,从“语言”列表中选择 C#,然后从“平台”列表中选择 Windows 。

    应用语言和平台筛选器之后,对 .NET Core 选择“控制台应用”模板,然后选择“下一步” 。

    为“控制台应用”选择 C# 模板

    备注

    如果未看到“控制台应用”模板,则可以通过“创建新项目”窗口安装该模板 。 在“找不到所需内容?”消息中,选择“安装更多工具和功能”链接 。 然后,在 Visual Studio 安装程序中,选择“.NET Core 跨平台开发”工作负载 。

  4. 在“配置新项目”窗口中,在“项目名称”框中键入或输入“GetStartedDebugging” 。 然后,选择“下一步”。

  5. 选择建议的目标框架 (.NET Core 3.1) 或 .NET 5,然后选择“创建”。

    此时,Visual Studio 将打开新项目。

创建应用程序

  1. 在 Program.cs 中,使用以下代码替换所有默认代码 :

    using System;
    class ArrayExample
    {
        static void Main()
        {
            char[] letters = { 'f', 'r', 'e', 'd', ' ', 's', 'm', 'i', 't', 'h'};
            string name = "";
            int[] a = new int[10];
            for (int i = 0; i < letters.Length; i++)
            {
                name += letters[i];
                a[i] = i + 1;
                SendMessage(name, a[i]);
            }
            Console.ReadKey();
        }
        static void SendMessage(string name, int msg)
        {
            Console.WriteLine("Hello, " + name + "! Count to " + msg);
        }
    }
    

启动调试器!

  1. 按 F5 (“调试”>“开始调试” )或调试工具栏中的“开始调试” 按钮开始调试

    通过 F5 启动应用时,调试器会附加到应用进程,但现在我们还未执行任何特殊操作来检查代码。 因此应用只会加载,控制台输出如你所见。

    Hello, f! Count to 1
    Hello, fr! Count to 2
    Hello, fre! Count to 3
    Hello, fred! Count to 4
    Hello, fred ! Count to 5
    Hello, fred s! Count to 6
    Hello, fred sm! Count to 7
    Hello, fred smi! Count to 8
    Hello, fred smit! Count to 9
    Hello, fred smith! Count to 10
    

    在本教程中,我们将使用调试器仔细查看此应用,并查看调试器功能。

  2. 按红色的停止停止调试按钮 (Shift + F5) 来停止调试器 。

  3. 在控制台窗口中,按某个键来关闭控制台窗口。

设置断点并启动调试器

  1. Main 函数的 for 循环中,通过单击以下代码行的左边距来设置断点:

    name += letters[i];

    设置断点的位置会出现一个红色圆圈的断点

    断点是可靠调试的最基本和最重要的功能之一。 断点指示 Visual Studio 应在哪个位置挂起你的运行代码,以使你可以查看变量的值或内存的行为,或确定代码的分支是否运行。

  2. 按“F5” 或“开始调试” 按钮开始调试,应用随即启动,调试器将运行到你设置断点的代码行。

    设置并命中断点

    黄色箭头表示调试器暂停处的语句,它还在同一点上暂停应用执行(此语句尚未执行)。

    如果应用尚未运行,则按 F5 会启动调试器并在第一个断点处停止 。 否则,按 F5 将继续运行应用至下一个断点 。

    当你知道要详细检查的代码行或代码段时,断点功能非常有用。 有关可设置的不同类型断点(如条件断点)的信息,请参阅使用断点

大多数情况下,我们使用键盘快捷方式,因为这是在调试器中快速执行应用的好方法(括号中显示了等效的命令,如菜单命令)。

  1. name += letters[i] 语句上暂停时,将鼠标悬停在 letters 变量上,会看到其默认值为数组中第一个元素的值 char[10]

    允许你检查变量的功能是调试器最有用的功能之一,并且有不同的方法来执行此操作。 通常,当尝试调试问题时,你试图找出变量是否存储了你期望它们在特定时间具有的值。

  2. 展开 letters 变量,查看其属性,其中包括变量包含的所有元素。

    Visual Studio 调试器的屏幕截图,其中突出显示了“name+= letters[I]”语句,并且图中包括一个显示了字母数组中的元素的下拉列表。

  3. 接下来,将鼠标悬停在 name 变量上,会看到其当前值为空字符串。

  4. 按两次 F10(或选择“调试”>“单步跳过”)前进到 SendMessage 方法调用,然后再按一次 F10 。

    按 F10 将使调试器前进到下一条语句,但不会单步执行应用代码中的函数或方法(代码仍将执行)。 在进行 SendMessage 方法调用时,通过按 F10,我们跳过了 SendMessage 的实现代码(我们现在可能对此不感兴趣)。

  5. 多按几次 F10(或“调试” > “单步跳过”),通过 for 循环执行多次循环访问,再次在断点处暂停,每次都将鼠标悬停在 name 变量上以检查其值 。

    Visual Studio 调试器的动画屏幕截图,其中显示在调试期间按 F10 以“单步执行”并迭代循环的效果。

    变量的值随 for 循环的每次迭代而更改,显示的值依次为 ffrfre,依此类推。 要在此方案中更快地前进到循环,可以按 F5 (或选择“调试器” > “继续”),此操作会使你前进到断点,而不是下一条语句 。

    通常情况下,在调试时,需要快速检查变量的属性值,以查看它们是否存储了你希望它们存储的值,可根据数据提示执行此操作。

  6. Main 方法的 for 循环中仍处于暂停状态时,按 F11(或选择“调试”>“单步执行”),直到在 SendMessage 方法调用处暂停 。

    你应该位于以下代码行:

    SendMessage(name, a[i]);

  7. 再按一次 F11 单步执行到 SendMessage 方法 。

    黄色指针会前进到 SendMessage 方法。

    使用 F11 单步执行代码

    F11 是“单步执行”命令,每按一次,应用就执行下一个语句 。 F11 是一种以最详尽方式检查执行流的好方法。 默认情况下,调试器会跳过非用户代码(如果需要更多详细信息,请参阅仅我的代码)。

    假设你已完成了对 SendMessage 方法的检查,并且希望退出该方法但保持位于调试器中。 可使用“单步跳出”命令执行此操作 。

  8. 按 Shift + F11(或“调试”>“单步跳出”) 。

    此命令将恢复应用执行(并使调试器前进),直到当前方法或函数返回。

    你应当回到 Main 方法的 for 循环,在 SendMessage 方法调用处暂停。 有关在代码中进行移动的不同方法的详细信息,请参阅浏览调试器中的代码

  1. 按 F5 再次前进到断点 。

  2. 在代码编辑器中,向下滚动并将鼠标悬停在 SendMessage 方法中的 Console.WriteLine 方法上,直到左侧出现绿色的“运行时单击”按钮运行时单击 。 按钮的工具提示显示“将执行运行到此处”。

    使用“运行时单击”功能

    备注

    “运行时单击”是 Visual Studio 2017 中的新增按钮 。 (如果未看到绿色箭头按钮,请在此示例中改为使用 F11 以使调试器前进到正确的位置。 )

  3. 单击“运行时单击” 按钮运行时单击

    调试器会前进到 Console.WriteLine 方法。

    使用此按钮类似于设置临时断点。 “运行时单击”对于快速到达应用代码的可见区域十分方便(你可在任何打开的文件中单击) 。

快速重启应用

单击调试工具栏中的“重启”重启应用按钮 (Ctrl + Shift + F5) 。

当你按下“重启”时,与停止应用并重启调试器相比,它节省了时间 。 调试器在执行代码命中的第一个断点处暂停。

调试器再次在你之前在 for 循环上设置的断点处停止。

使用“自动”和“局部变量”窗口检查变量

  1. 查看代码编辑器底部的“自动”窗口 。

    如果已关闭,请依次选择“调试” > “Windows” > “自动”,在调试器中暂停时将其打开 。

    在“自动”窗口中,可看到变量及其当前值 。 “自动”窗口显示当前行或前一行使用的所有变量(检查文档中特定于语言的行为) 。

  2. 接下来,我们来看看“自动”窗口旁边的选项卡中的“局部变量”窗口 。

  3. 展开 letters 变量以显示其包含的元素。

    检查局部变量窗口中的变量

    “局部变量”窗口显示当前作用域中的变量,即当前执行上下文 。

设置监视

  1. 在主代码编辑器窗口中,右键单击 name 变量,然后选择“添加监视” 。

    “监视”窗口将在代码编辑器的底部打开 。 可使用“监视”窗口指定要关注的变量(或表达式) 。

    现在,你在 name 变量上设置好了监视,当你在调试器中移动时,可看到其值发生变化。 与其他变量窗口不同,“监视”窗口始终显示你正在监视的变量(当超出作用域时,它们会变灰) 。

检查调用堆栈

  1. for 循环中暂停时,单击“调用堆栈”窗口,默认情况下,该窗口在右下方窗格中打开 。

    如果已关闭,请依次选择“调试” > “Windows” > “调用堆栈”,在调试器中暂停时将其打开 。

  2. 单击多次 F11,直至看到调试器在 SendMessage 方法中暂停 。 查看“调用堆栈”窗口 。

    检查调用堆栈

    “调用堆栈”窗口显示方法和函数被调用的顺序 。 最上面一行显示当前函数(此应用中的 SendMessage 方法)。 第二行显示 SendMessage 是从 Main 方法调用的,依此类推。

    备注

    “调用堆栈”窗口类似于某些 IDE(如 Eclipse)中的调试透视图 。

    调用堆栈是检查和理解应用执行流的好方法。

    可双击代码行来查看该源代码,这也会更改调试器正在检查的当前作用域。 此操作不会使调试器前进。

    还可使用“调用堆栈”窗口中的右键单击菜单执行其他操作 。 例如,你可将断点插入到指定的函数中,使用“运行到光标处”推进调试器,然后检查源代码 。 有关详细信息,请参阅如何:检查调用堆栈

更改执行流

  1. 按两次 F11 以运行 Console.WriteLine 方法 。

  2. SendMessage 方法调用中暂停调试器后,使用鼠标抓住左侧的黄色箭头(执行指针),将黄色箭头向上移动一行,返回到 Console.WriteLine

  3. 按下 F11 。

    调试器将重新运行 Console.WriteLine 方法(你会在控制台窗口输出中看到)。

    通过更改执行流,你可以进行测试不同代码执行路径或重新运行代码等操作,而无需重启调试器。

    警告

    通常你需要小心使用此功能,工具提示中会出现警告。 你也可能会看到其他警告。 移动指针无法将应用程序还原到更早的应用状态。

  4. 按 F5 继续运行应用 。

    恭喜你完成本教程!

后续步骤

在本教程中,你已了解了如何启动调试器、逐步执行代码以及检查变量。 你可能会希望更深入地了解调试器功能以及查看指向更多信息的链接。