什么是 C# 开发工具包？

C# 开发工具包 是一个旨在增强您在 Visual Studio Code 中的 C# 开发体验的扩展。它旨在为 VS Code 提供更全面、更高效、更可靠的 C# 体验。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# 开发工具包

适用于 C# 开发工具包的 IntelliCode

.NET MAUI

Unity

这些扩展的使用受 C# 开发工具包系列扩展的最终用户许可协议 的约束。

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

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

当您尝试编辑 C# 文件时，C# 开发工具包未激活的原因有很多。

未安装 C# 扩展的 2.0+ 版本 。C# 开发工具包需要 C# 扩展的 2.0 或更高版本。请检查您是否已安装 C# 扩展，以及您的版本是否为 2.0 或更高版本。

工作区优先使用 C# 扩展 。C# 开发工具包不支持 .NET Framework 项目，如果您已将 dotnet.preferCSharpExtension 设置设置为 true，则该工作区的 C# 开发工具包将被禁用。如果项目不是 .NET Framework 项目，请确保禁用此设置。

使用只读操作系统 。C# 开发工具包需要对其自己的扩展文件夹以及 VS Code 提供的扩展文件夹具有写入权限，以便在操作系统中写入任意状态，因此，如果您使用的是完全只读的操作系统，则 C# 开发工具包将无法工作。

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

许可和贡献

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

C# 开发工具包通过社区许可证提供给符合条件的用户，并且还作为现有 Visual Studio 订阅 的另一个补充提供。这意味着 C# 开发工具包目前可供拥有有效 Visual Studio 订阅的开发人员使用。

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

在哪里提交反馈和建议？

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

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

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

我该如何贡献？

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

此项目已采用由 Contributor Covenant 定义的行为准则，以阐明我们社区中预期的行为。有关更多信息，请参阅 .NET Foundation 行为准则 。通过签署 CLA ，社区可以自由地将您的贡献用于 .NET Foundation 项目。

.NET SDK

安装脚本超时

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

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

"dotnetAcquisitionExtension.installTimeoutValue" : 180

获取 .NET SDK 失败

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

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

如何手动安装 .NET？

如果 .NET 安装失败或您想重用现有的 .NET 安装，可以使用 dotnetAcquisitionExtension.existingDotnetPath 设置。您可以从**C# Dev Kit 演练**或 .NET 网站 手动安装 .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 项目。

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

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

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

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

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

项目系统报告遇到了问题

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

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

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

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

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

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

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

要解决此问题，请更新 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 ) 来构建您的解决方案。构建完成后，您的测试将出现在测试资源管理器面板中。

当我按 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 应用程序。对于测试项目，您可以使用测试资源管理器有效地调试代码。

调试时，我的断点没有绑定

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

C# 编辑器

如何使 IntelliSense 正确工作？

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

进行此更改后，通过打开命令面板（ ⇧⌘P (Windows、Linux Ctrl+Shift+P ) ），然后键入“Reload Window”并按 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+, ) ）。在搜索栏中，键入“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。如果文件只有几 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# Dev Kit 调试器设置 中启用了热重载选项时，调试器才会启动热重载会话。如果启用了该选项，则预计在调试期间状态栏中会显示热重载图标。

您可以单击热重载图标，也可以通过打开“C# 热重载”输出窗口查看诊断信息。如果两者都看不到，则该项目可能不受 C# Dev Kit 扩展支持，请参阅 热重载支持的项目 。

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

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