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

How to import an EditorConfig file into Visual Studio for all solutions?

如何将代码约定(代码格式设置)从 EditorConfig 文件导入 Visual Studio?

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

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

正在创建 EditorConfig 文件

如果您愿意,可以创建一个空文本文件,然后只添加您想要的设置。但是,Visual Studio 可以为您创建一个具有 .NET 合理默认值的 .editorconfig 文件。来自 MSDN:

  • 从菜单栏中选择 项目 > 添加新项;或按 Ctrl+Shift+A

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

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

在 Visual Studio 2019 年,您可以改为 create an EditorConfig file from your current settings。只需在 Text Editor > C# > Code Style > General 下的 选项 对话框中单击以下按钮:

跨解决方案共享 EditorConfig

要在解决方案和项目之间共享设置,您需要在顶级 directory/solutions 文件夹中创建一个 .editorconfig 文件。例如,我在主干中有我的,并将其提交到源代码管理,以便我的同事共享相同的设置。

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

有关详细信息,请参阅 File hierarchy and precedence

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