现已推出！阅读有关 11 月的新功能和修复的信息。

C# 开发工具包常见问题解答

使用此常见问题解答 (FAQ) 主题，详细了解 C# 开发工具包扩展，并解决您可能遇到的问题。

常规

什么是 C# 开发工具包？

C# 开发工具包是一个旨在增强 Visual Studio Code 中 C# 开发体验的扩展。它的目标是将更广泛、更高效、更可靠的 C# 体验带到 VS Code。C# 开发工具包不会替换现有的 C# 扩展，而是在其提供的出色语言服务功能之上进行添加。开发人员可以选择继续使用现有 C# 扩展的更新版本，也可以通过添加 C# 开发工具包来增强他们的体验。

当前支持哪些项目类型？

C# 开发工具包支持为 .NET Core（通常也称为 .NET）构建 Web 应用、控制台应用、类库项目和测试项目。.NET MAUI 扩展和Unity 扩展构建在 C# 开发工具包之上，并为构建.NET 多平台应用 UI (MAUI) 应用和 Unity 应用提供其他支持。这些扩展支持现代 .NET 项目格式，也称为“sdk 风格”项目。如果您正在构建非 SDK 格式的项目（如.NET Framework 应用和 Xamarin 应用），请参阅“项目系统”部分。

C# 开发工具包中包含哪些扩展？

目前，C# 开发工具包系列中包含的扩展是

这些扩展的使用受C# 开发工具包系列扩展的 EULA约束。

这些扩展还具有携带其自身许可的依赖项 - 例如，C# 开发工具包依赖于C# 扩展和.NET 安装工具。

为什么 C# 开发工具包没有激活 / 找不到 C# 开发工具包命令？

C# 开发工具包在您尝试编辑 C# 文件时未激活有几个原因。

  1. 未安装 C# 扩展的 2.0+ 版本。C# 开发工具包需要 C# 扩展的 2.0 或更高版本。请检查以确保您已安装 C# 扩展，并且版本为 2.0 或更高版本。
  2. 工作区首选 C# 扩展。C# 开发工具包不支持 .NET Framework 项目，如果您已将 dotnet.preferCSharpExtension 设置设置为 true，则将为该工作区禁用 C# 开发工具包。如果项目不是 .NET Framework 项目，请确保禁用此设置。
  3. 使用只读 OS。C# 开发工具包需要对其自己的扩展文件夹和 VS Code 提供的扩展文件夹的写入权限，以便在操作系统内写入任意状态，因此如果您使用的是完全只读的操作系统，则 C# 开发工具包将无法工作。

如果您已检查过这些项，并且仍然找不到 C# 开发工具包命令，请报告问题并提供 C# 开发工具包的“输出”窗口中的信息。

许可和贡献

谁可以使用 C# 开发工具包？

C# 开发工具包可通过社区许可证提供给符合条件的用户，并且也作为现有Visual Studio 订阅的另一项附加功能提供。这意味着拥有有效 Visual Studio 订阅的开发人员现在可以使用 C# 开发工具包。

对于个人、学术和开源项目，C# 开发工具包可以免费使用。对于商业用途，最多 5 人的团队也可以免费使用 C# 开发工具包。对于 6 个或更多开发人员，这些用户需要 Visual Studio Professional（或更高版本）订阅。C# 开发工具包也包含在 GitHub Codespaces 和 Microsoft Dev Box 中，因此这些产品的用户可以免费访问 C# 开发工具包。

我在哪里提交反馈和建议？

用户可以通过 VS Code 的帮助 > 报告问题来报告问题或建议。选择是错误、功能请求还是性能问题，在扩展上提交，然后从扩展列表中选择 C# 开发工具包。

Help > Report Issue image

C# 开发工具包是否开源？为什么不？

不是。C# 开发工具包是闭源的，但依赖于 VS Code 的 C# 扩展（它是开源的），并且两者都与开源组件（如Roslyn 和Razor）通信。C# 开发工具包的目标之一是为使用 VS Code 的 C# 开发人员提供改进的生产力体验。为了实现此目标，C# 开发工具包包含一些与我们的其他工具共享的专有、闭源功能。为了使这些体验可供 VS Code 用户使用，我们需要将 C# 开发工具包作为闭源扩展引入。

我如何贡献？

C# 扩展（它是 C# 开发工具包的一部分）是完全开源的，并受这些许可条款的约束。此扩展的源代码可在https://github.com/dotnet/vscode-csharp上获得，并根据 MIT 许可证获得许可。

此项目已采用贡献者公约定义的行为准则，以明确我们社区中期望的行为。有关详细信息，请参阅.NET 基金会的行为准则。通过签署CLA，社区可以自由使用您对 .NET 基金会项目的贡献。

.NET SDK

安装脚本超时

请注意，根据您的网络速度，安装 .NET Core 运行时可能需要一些时间。默认情况下，如果完成时间超过 4.5 分钟，安装将不成功终止。如果您认为允许下载的时间太少（或太多），您可以通过将 dotnetAcquisitionExtension.installTimeoutValue 设置为自定义值来更改超时值。

了解有关配置 VS Code 设置的更多信息，并查看下面的示例，了解如何在 settings.json 文件中自定义超时。在此示例中，自定义超时值为 180 秒，即 3 分钟

{
  "dotnetAcquisitionExtension.installTimeoutValue": 180
}

获取 .NET SDK 时出错

Error acquiring .NET SDK

注意：如果您位于中国，您的 .NET SDK 下载可能会被阻止并导致超时。

您需要确保已安装 .NET SDK。作为一种解决方法，您可以将 .NET 运行时获取扩展指向现有的 .NET 安装

Point the .NET runtime acquisition extension to an existing .NET SDK install

如何手动安装 .NET？

如果 .NET 安装失败，或者您想重用现有的 .NET 安装，可以使用 dotnetAcquisitionExtension.existingDotnetPath 设置。.NET 可以从 C# Dev Kit 演练或 .NET 网站手动安装。要将扩展指向该安装，请使用扩展 ID 和路径更新您的设置，如下所示

Windows

{
  "dotnetAcquisitionExtension.existingDotnetPath": [
    {
      "extensionId": "msazuretools.azurerm-vscode-tools",
      "path": "C:\\Program Files\\dotnet\\dotnet.exe"
    }
  ]
}

macOS

{
  "dotnetAcquisitionExtension.existingDotnetPath": [
    {
      "extensionId": "msazuretools.azurerm-vscode-tools",
      "path": "/usr/local/share/dotnet/dotnet"
    }
  ]
}

扩展认为我处于离线状态，并返回 400 或 407 错误响应，而我使用了代理

如果您的系统使用代理并且禁用了注册表访问，则需要在扩展设置中显式设置代理 URL。当通过环境变量和注册表设置代理时，会自动检测到代理，但如果您的代理仅通过注册表项管理并且禁用了注册表访问，则扩展无法找到它。要设置代理 URL，请添加以下扩展设置

{
  "dotnetAcquisitionExtension.proxyUrl": "https://your_proxy_url:port"
}

项目系统

解决方案资源管理器报告我的项目在 C# Dev Kit 中不受支持

这通常是因为项目目标是 .NET Framework 而不是 .NET Core/.NET。目前，C# Dev Kit 不支持 .NET Framework 项目。

Project Not Supported in Solution Explorer

要解决此问题，您有两个选择。

您可以更新您的项目为 SDK 样式的项目，以访问所有可用的 C# Dev Kit 功能。

或者，您可以将项目和解决方案加载委托给 C# 扩展，在设置编辑器中使用 首选 C# 扩展工作区设置。请记住，使用此设置时，某些 C# Dev Kit 功能将不可用。要访问此设置，请转到设置编辑器并选择 工作区 选项卡。然后，在搜索栏中搜索“首选 C#”，并选中 首选 C# 扩展设置旁边的复选框。如果您尝试加载 .NET Framework 项目，C# Dev Kit 将自动显示一个通知，要求您将项目更新为 SDK 样式的项目，或通过从通知中选择 使用 C# 扩展 让 C# 扩展加载您的项目或解决方案。此选项将自动选择 首选 C# 扩展设置。请注意，您需要重新加载 VS Code，此设置才能生效。

我单击了“创建 .NET 项目”按钮，但没有任何反应

这通常发生在扩展版本不匹配时。C# Dev Kit 需要 C# 扩展的 2.0 或更高版本。如果您使用的是 C# 扩展的 v1 版本，则 C# Dev Kit 和 C# Dev Kit 相关命令将无法正常工作。要解决此问题，请将 C# 扩展升级到最新版本。

项目系统报告遇到了问题

当发生内部项目系统错误时，您通常会在 VS Code 的某个角落看到如下弹出通知

Failed to Restore Solution

选择 打开日志 按钮以打开一个视图，其中显示问题发生位置的堆栈跟踪。选择并复制日志中的所有文本。通过 VS Code 报告问题，并确保包含日志中复制的文本。

当我打开我的解决方案时，收到“未能还原解决方案”的通知

选择 显示错误。这将打开 NuGet 的输出面板。通读错误信息，以确定包还原无法完成的原因。如果您无法解决问题，请通过 VS Code 报告问题。

解决方案资源管理器显示“未找到兼容的 .NET SDK”

此错误的最可能原因是 global.json 文件指定了与系统上安装的 SDK 不同的 SDK。

A compatible .NET SDK was not found

打开输出窗口并切换到 项目 窗格以查找更多信息。您应该会看到类似这样的内容

Output Window Projects Pane

要解决此问题，请更新 global.json 以指定已安装的 SDK，或从 下载 .NET 页面安装指定的 SDK。

接下来，关闭并重新打开工作区。

也可能是 SDK 未安装在 C# Dev Kit 已知的位置。例如，如果 SDK 是通过包管理器而不是通过 Microsoft 提供的安装程序安装的，则可能会发生这种情况。要解决此问题，请通过包管理器卸载 SDK，然后通过 下载 .NET 安装它。

测试资源管理器

为什么我的测试没有出现在测试资源管理器面板中？

请确保您的解决方案包含测试项目。只有属于已打开解决方案的测试项目才会被包含在内。要查看测试项目是否属于解决方案，请在文件资源管理器中打开解决方案资源管理器视图，并查看该项目是否出现在树中。右键单击解决方案节点以添加现有测试项目，或在解决方案中创建新的测试项目。

C# Dev Kit 还要求它在测试出现在测试资源管理器面板之前成功构建了您的项目。此外，如果在您的项目/解决方案上完成 清理，则测试 dll 将从测试资源管理器面板中删除。

在您验证了您的测试项目是解决方案的一部分后，通过右键单击解决方案资源管理器中的解决方案并选择 生成 或使用 ⇧⌘B (Windows, Linux Ctrl+Shift+B) 构建您的解决方案。一旦构建完成，您的测试将出现在测试资源管理器面板中。

我的测试出现在测试资源管理器面板中，但我无法调试它们

请确保您的测试以 NET Core 为目标。C# Dev Kit 不支持 .NET Framework 项目，尽管 .NET Framework 项目可能会加载并显示为正常工作。VS Code 中的调试器不支持 .NET Framework。

我刚向我的测试项目添加了新测试，但它们没有出现在测试资源管理器面板中？

C# Dev Kit 要求它在测试出现在测试资源管理器面板之前成功构建了您的项目。

通过右键单击解决方案资源管理器中的解决方案并选择 生成 或 ⇧⌘B (Windows, Linux Ctrl+Shift+B) 构建您的解决方案。一旦构建完成，您的测试将出现在测试资源管理器面板中。

如何收集日志以解决测试资源管理器的问题？

如果您在测试资源管理器中遇到问题，您可以启用诊断日志记录以收集更多信息进行故障排除

  1. 增加测试资源管理器的详细程度：导航到 C# Dev Kit 设置并将测试资源管理器详细程度设置从 minimal 增加到 diagnostic。这将生成更详细的日志。
  2. 检查输出窗口：在 Visual Studio Code 中打开输出窗口，并从下拉列表中选择 C# Dev Kit - 测试资源管理器。诊断消息将显示 [dev] 前缀。
  3. 收集以下信息：报告问题时，请确保包含
    • 输出窗口中的诊断日志。
    • 您的操作系统和版本（例如，Windows 10、macOS 13）。
    • 您正在使用的 C# Dev Kit 扩展的版本。转到扩展视图，并将鼠标悬停在扩展上以查看版本信息。

这些信息将有助于更有效地诊断和解决问题。

调试器

当我按 F5 时，没有任何反应

请确保您打开了一个 C# 项目，或者活动文档是 .cs 或 .razor 文件。如果调试器仍然无法加载，请确保 C# Dev Kit 和 C# 扩展都已激活。

当我按 F5 时，它要求我“选择一个调试器”。我如何知道选择哪一个？

如果您尝试调试 .NET 控制台应用程序、Blazor 服务器应用程序、Blazor WebAssembly 或 Web 应用程序，请确保选择 C# 选项。其他选项可能是其他扩展的一部分，例如用于 JavaScript 调试的 Node 或用于 Python 调试的 Python，它们不是 C# Dev Kit 的一部分。

当我按 F5 时，它提示我输入密码（仅限 macOS）

macOS 默认禁用开发者模式，如果程序想用作调试器，则会提示密码以保护用户。

如果您想禁用这些提示，您可以运行以下命令

  • DevToolsSecurity --enable
  • sudo dscl . append /Groups/_developer GroupMembership $USER

为什么调试不起作用？

如果您尝试调试库或测试项目，您可能需要采取一些额外的步骤来确保正确调试您的代码。要调试库，您可以创建一个与库交互的控制台或 Web 应用程序。对于测试项目，您可以使用测试资源管理器来有效地调试您的代码。

调试时，我的断点未绑定

您正在调试的进程不是在调试中构建的，请确保在调试进程之前以调试方式构建。

C# 编辑器

如何使 IntelliSense 正常工作？

请确保您已打开项目或解决方案。如果您有多个解决方案，扩展将自动打开一个或提示您打开一个。接下来，在“设置”搜索栏中搜索“跟踪”，并将 Dotnet > 服务器: 从下拉列表中设置为 跟踪。此选项提供更多输出信息，以帮助开发人员团队诊断问题。

Set Dotnet Server to Trace

做出更改后，通过打开命令面板（⇧⌘P（Windows、Linux Ctrl+Shift+P）），然后键入“重新加载窗口”并按 Enter 来重新加载窗口。重新加载窗口后，查看“输出”面板中的项目日志（⇧⌘U（Windows Ctrl+Shift+U，Linux Ctrl+K Ctrl+H）），然后从下拉列表中选择项目。这将显示与项目未完全加载相关的任何错误。复制“输出”面板中的所有文本，并通过 VS Code 报告问题，确保包含复制的文本。

C# 扩展无法启动服务器

作为一种解决方法，你可以使用 dotnetAcquisitionExtension.existingDotnetPath 设置将 .NET 运行时获取扩展指向现有的 .NET 7 安装。

{
  "dotnetAcquisitionExtension.existingDotnetPath": [
    {
      "extensionId": "msazuretools.azurerm-vscode-tools",
      "path": "C\\Program Files\\dotnet\\dotnet.exe"
    }
  ]
}

我得到的诊断信息太多或太少

C# 扩展 允许你配置各种后台代码分析设置。要访问这些设置，请转到 文件 > 首选项 > 设置，或使用键盘快捷键（⌘,（Windows、Linux Ctrl+,））。在搜索栏中，键入“分析”以缩小与代码分析相关的设置范围。在运行以下项的后台代码分析：下，你可以从下拉菜单中选择分析范围。默认设置为分析打开的文件，但你可以将其自定义为完整解决方案、无或打开的文档。

Configure Background Code Analysis

你还可以使用 EditorConfig 文件来配置诊断和代码分析。要了解有关 EditorConfig 的更多信息，请查看文档。

如果你没有看到足够的诊断信息或根本没有看到任何诊断信息，则可能是你的项目未完全加载。要检查是否是这种情况，请参阅如何使 IntelliSense 正常工作？部分。其中提供了关于如何验证项目是否已完全加载的说明。

Razor 编辑器

大多数或所有 Blazor 组件都显示警告

在可以发现 Blazor 组件之前，C# 开发工具包需要成功加载你的项目。此外，Razor 语言服务器需要生成一个 project.razor.vscode.bin 文件，才能了解你的项目的状态。如果未生成此文件，或者生成的文件没有任何组件，则可能会影响 Razor 体验。

为了提高性能，扩展有时会延迟生成或加载此文件，直到你打开你的第一个 .razor 或 .cshtml 文件。为了确保你尝试使用的项目在“解决方案资源管理器”中没有错误，请仔细检查它。

如果你的项目已正确加载，请验证文件系统中 obj\Debug\<tfm> 文件夹中是否存在 project.razor.vscode.bin 文件。由于它是一个二进制文件，因此直接验证文件的内容并不简单，但通常大多数 Razor 项目应生成至少 150KB 大小的文件。如果该文件只有几 KB，则表示标记助手和/或组件可能未被正确发现。

要强制重新生成文件，请关闭所有打开的 .razor 或 .cshtml 文件，重新加载 VS Code 窗口，并在项目正确加载后，打开任何 .razor 或 .cshtml 文件以触发重新生成过程。

Razor 文件中提到了目标框架错误

Razor 语言服务器通常没有“解决方案”的概念，而是根据项目 obj\Debug\<tfm> 文件夹中是否存在 project.razor.vscode.bin 文件来加载项目。有时，来自不再使用的目标框架的旧文件可能会导致混淆，使 Razor 服务器认为项目是多目标的，或者某些组件仍然被引用，而实际上它们并没有被引用。

要解决此问题，请清除 obj 文件夹中的旧文件夹或清除所有文件夹。然后，重新加载 VS Code 窗口并打开一个 .razor 文件。这应该确保生成新的 JSON 文件，并删除旧文件。

IntelliCode

我没有获得整行补全

当启用了 GitHub Copilot 扩展时，将禁用整行补全，以允许你利用更高级的 AI 补全 功能。你可以通过检查 VS Code 右下角是否存在 Copilot 徽标来验证是否已启用 Copilot。

热重载

开始调试后未显示热重载图标

仅当在 C# 开发工具包的 调试器设置中启用热重载选项时，调试器才会启动热重载会话。如果启用了该选项，则在调试时，热重载图标应该会出现在状态栏中。

Hot Reload icon in the bottom bar

你可以单击热重载图标，或者可以通过打开 C# 热重载“输出”窗口来查看诊断信息。如果你没有看到任何一个，则可能是 C# 开发工具包扩展不支持该项目，请参阅 热重载支持的项目。

热重载支持哪些类型的编辑？

有关热重载支持的 C# 代码更改列表，请参阅 支持的代码更改。

5/3/2024