如何为所有解决方案将 EditorConfig 文件导入 Visual Studio？

Question

如何将代码约定（代码格式设置）从 EditorConfig 文件导入 Visual Studio？

我希望.editorconfig所有解决方案都有一个文件，而不是每个项目一个。

Answer 1

Visual Studio 2017 及更高版本支持 EditorConfig。

创建 EditorConfig 文件

如果您愿意，您可以创建一个空文本文件并添加您想要的设置。但是，Visual Studio 可以.editorconfig为您创建具有合理默认值的 .NET 文件。从MSDN：

• 从菜单栏中，选择Project > Add New Item；或按Ctrl+Shift+A

• 选择editorconfig File (.NET)模板以添加预先填充了默认 .NET 代码样式、格式和命名约定的 EditorConfig 文件

Visual Studio 2019 - 从当前设置创建 EditorConfig 文件

在 Visual Studio 2019 中，您可以改为从当前设置创建 EditorConfig 文件。只需单击选项对话框中的以下按钮Text Editor > C# > Code Style > General：

跨解决方案共享 EditorConfig

要在解决方案和项目之间共享设置，您需要.editorconfig在顶级目录/解决方案文件夹中创建一个文件。例如，我在主干中有我的，我将它提交给源代码控制，以便我的同事共享相同的设置。

此文件中的设置适用于主干和子文件夹中的所有项目，除非被.editorconfig文件夹树下方的另一个文件覆盖，例如，您可能在具有不同设置的子文件夹中有项目特定的 EditorConfig 文件。您不需要“导入”文件 - 它应该被自动检测到。

有关更多详细信息，请参阅文件层次结构和优先级。

如果您使用的是 Visual Studio 2019，我建议您使用Generate .editorconfig file from settings上面详述的按钮，并将.editorconfig文件保存到您的解决方案文件夹。否则，您可以创建一个一次性项目，创建配置文件，然后将该文件剪切并粘贴到它需要存在的文件夹中。