在 VS Code 中试用！

使用 C# Dev Kit 进行测试

Visual Studio Code 中的 C# 测试功能由 C# Dev Kit 扩展提供。它是一个轻量级扩展，旨在增强您的 C# 开发体验。

概述

该扩展支持以下测试框架

C# Dev Kit 扩展提供以下功能

  • 运行/调试测试用例
  • 查看测试报告
  • 在测试资源管理器中查看测试

要求

项目设置

注意：如果您已经在项目中设置了 C# 测试框架，则可以跳到功能部分。

为项目启用测试并添加测试框架包

您只需在解决方案资源管理器中执行几个步骤即可为项目启用测试框架

xUnit

打开命令面板，选择 .NET:New Project..，然后选择 xUnit Test Project 并为新项目提供名称和位置。这将创建一个新项目和目录，该项目和目录使用 xUnit 作为测试库，并通过将以下 <PackageReference /> 元素添加到项目文件来配置测试运行器。

  • Microsoft.NET.Test.Sdk
  • xunit
  • xunit.runner.visualstudio
  • coverlet.collector

在终端中，运行以下命令

dotnet add [location of your test csproj file] reference [location of the csproj file for project to be tested]

NUnit

打开命令面板，选择 .NET:New Project..，然后选择 NUnit3 Test Project 并为新项目提供名称和位置。这将创建一个新项目和目录，该项目和目录使用 NUnit 作为测试库，并通过将以下 <PackageReference /> 元素添加到项目文件来配置测试运行器。

  • Microsoft.NET.Test.Sdk
  • nunit
  • NUnit3TestAdapter

在终端中，运行以下命令

dotnet add [location of your test csproj file] reference [location of the csproj file for project to be tested]

MSTest

打开命令面板，选择 .NET:New Project..，然后选择 MSTest Test Project 并为新项目提供名称和位置。这将创建一个新项目和目录，该项目和目录使用 MSTest 作为测试库，并通过将以下 <PackageReference /> 元素添加到项目文件来配置测试运行器。

  • Microsoft.NET.Test.Sdk
  • MSTest.TestAdapter
  • MSTest.TestFramework
  • coverlet.collector

在终端中，运行以下命令

dotnet add [location of your test csproj file] reference [location of the csproj file for project to be tested]

功能

运行/调试测试用例

编写测试用例后，您需要对测试项目进行构建，以便将其识别为测试。打开命令面板，选择 .NET: Build。这将构建您的项目。

C# Dev Kit 会在类和方法的定义左侧生成快捷方式（绿色播放按钮）。要运行目标测试用例，请选择绿色播放按钮。您也可以右键单击它以查看更多选项。

测试资源管理器

测试资源管理器是显示工作区中所有测试用例的树状视图。您可以选择 Visual Studio Code 左侧活动栏中的烧杯按钮来打开它。您也可以从此处运行/调试测试用例并查看其测试结果。如果您的项目尚未构建，请选择刷新测试按钮来执行构建并发现所有测试。

C# Dev Kit 中的代码覆盖率

C# Dev Kit 现在通过 VS Code 代码覆盖率 API 支持代码覆盖率。此功能允许您通过显示测试期间哪些代码行被执行以及哪些未被执行来衡量测试的有效性。

代码覆盖率是衡量由自动化测试执行的代码库百分比的指标。它有助于识别未经测试的代码部分，并通过确保全面覆盖来提高测试质量。

注意：要启用代码覆盖率，请确保您已安装最新版本的 C# Dev Kit。

要运行具有代码覆盖率的测试，请执行以下步骤

    1. 从活动栏打开测试资源管理器。
    1. 选择并运行具有覆盖率的测试：选择要运行的测试并以覆盖率模式执行它们。
    1. 查看覆盖率数据：代码覆盖率数据会自动生成并与您在测试资源管理器中的测试结果一起显示。

如果您已生成覆盖率报告并想在 VS Code 中查看结果

    1. 使用命令面板：打开命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 并搜索“测试: 显示覆盖率”以访问覆盖率数据。
    1. 查看编辑器中高亮显示的代码覆盖率
    • 绿线：表示已测试的代码。
    • 红线：表示未经测试的代码。
    1. 测试资源管理器摘要：测试资源管理器提供整体覆盖率摘要，并允许您浏览需要额外测试的特定文件或方法。

提高代码的测试覆盖率

  • 检查覆盖率报告（在测试资源管理器或编辑器中）以识别标记为红色的区域，这些区域表示未经测试的代码。
  • 创建新测试以覆盖报告中突出显示的未经测试的区域。
  • 重新运行测试并查看更新后的覆盖率，以确保您的代码得到充分测试。

查看测试结果

运行/调试测试用例后，相关测试项的状态将在编辑器装饰和测试资源管理器中更新。

View test results

您可以选择堆栈跟踪中的链接以导航到源位置。

VS Code 测试命令

可以通过在命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 中搜索 Test: 来找到测试命令（例如，运行所有测试）。

Testing command in Command Palette

VS Code 测试设置

可以通过在设置编辑器 (⌘, (Windows, Linux Ctrl+,)) 中搜索 Testing 来找到特定于测试的 VS Code 设置。

Testing settings

3/12/2025