– 代理会话日，2月19日

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

使用本常见问题解答 (FAQ) 了解有关 C# 开发工具包扩展的更多信息，并解决您可能遇到的问题。

通用

什么是 C# 开发工具包？

C# 开发工具包 是一个旨在增强您在 Visual Studio Code 中 C# 开发体验的扩展。它旨在为 VS Code 带来更全面、更高效、更可靠的 C# 体验。C# 开发工具包不会取代现有的 C# 扩展，而是在其提供的优秀语言服务功能之上进行扩展。开发人员可以选择继续使用更新的 C# 扩展版本，或者通过添加 C# 开发工具包来增强他们的体验。

当前支持哪些项目类型？

C# 开发工具包支持构建 Web 应用程序、控制台应用程序、类库项目和针对 .NET Core 的测试项目，通常也称为 .NET。 .NET MAUI 扩展 和 Unity 扩展 构建在 C# 开发工具包之上，并为构建 .NET 多平台应用 UI (MAUI) 应用程序和 Unity 应用程序提供额外的支持。这些扩展支持现代 .NET 项目格式，也称为“sdk-style”项目。如果您正在构建非 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. 使用只读操作系统。C# 开发工具包需要对其自身的扩展文件夹以及 VS Code 提供的扩展文件夹具有写入权限，以便在操作系统内写入任意状态。因此，如果您使用的是完全只读的操作系统，则 C# 开发工具包将无法工作。

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

许可和贡献

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

C# 开发工具包通过社区许可提供给符合条件的用户，并且也包含在现有的 Visual Studio 订阅 中。这意味着 C# 开发工具包今天就可以供拥有有效 Visual Studio 订阅的开发人员使用。

对于个人、学术和开源项目，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# 开发工具包入门指南 或 .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# 开发工具包中不受支持

通常，这是因为项目针对的是 .NET Framework 而不是 .NET Core/.NET。 此时，C# 开发工具包不支持 .NET Framework 项目。

Project Not Supported in Solution Explorer

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

您可以 将您的项目 更新为 SDK 样式项目，以访问所有可用的 C# 开发工具包功能。

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

我单击了“创建 .NET 项目”按钮，但什么也没发生

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

项目系统报告遇到问题

当发生内部项目系统错误时，您通常会在 VS Code 的一个角落看到类似这样的通知

Failed to Restore Solution

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

当我打开解决方案时，我收到“解决方案恢复失败”的通知

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

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

此错误的 most likely cause 是一个 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 SDK：确保您正在使用适用于您的平台和计算机的受支持的 .NET Core SDK。某些 SDK 在特定的操作系统或体系结构上不起作用。有关更多信息，请查看官方 .NET 下载页面：https://dotnet.microsoft.com/en-us/download。
  • 有效的 SDK 安装：验证是否检测到有效的 SDK 安装。您可以 启用诊断日志 以检查为您的 .NET 项目检测到哪个 SDK。请注意，通过不受支持的工具（如 ASDF 或 Mise）安装的 .NET SDK 可能无法检测到，因为它们偏离了 Microsoft 的官方安装方法。我们建议遵循 官方说明。
  • 构建输出：确认构建已完成并生成了相应的输出二进制文件，例如 .dll 或 .exe 文件。
  • 项目加载：确保所有项目都已完成加载。在“解决方案资源管理器”中，查找测试项目旁边的测试图标，以确认它们已被检测到。

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

确保您的测试正在定位 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 Server 应用程序、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 正常工作？

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

Set Dotnet Server to Trace

完成此更改后，通过打开命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P))，键入“Reload Window”并按 Enter 重新加载窗口。重新加载窗口后，检查“输出”面板中的项目日志 (⇧⌘U (Windows Ctrl+Shift+U, Linux Ctrl+K Ctrl+H)) 并从下拉菜单中选择“**项目**”。这将显示与您的项目未完全加载相关的任何错误。复制“输出”面板中的所有文本，并通过 VS Code 报告问题，确保包含复制的文本。

C# 扩展无法启动服务器

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

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

我收到太多的诊断信息，或者我没有收到足够的诊断信息

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

Configure Background Code Analysis

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

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

Razor 编辑器

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

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

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

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

要强制文件重新生成，请关闭所有打开的 .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 补全 功能。 您可以通过检查 Copilot 标志是否出现在 VS Code 的右下角来验证 Copilot 是否已启用。

热重载

调试启动后，热重载图标未出现

调试器仅在 C# Dev Kit 调试器设置 中启用了热重载选项时，才会启动热重载会话。 如果启用了该选项，则预计在调试时状态栏中会出现热重载图标。

Hot Reload icon in the bottom bar

您可以单击热重载图标，或通过打开 C# 热重载 输出窗口查看诊断信息。 如果您没有看到这两者中的任何一个，则该项目可能不受 C# Dev Kit 扩展的支持，请参阅 支持热重载的项目。

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

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

5/3/2024
English 한국어 中文(简体) 中文(繁體)
© . This site is unofficial and not affiliated with Microsoft.