13

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

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

4

1 回答 1

14

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文件保存到您的解决方案文件夹中。否则,您可以创建一个一次性项目,创建配置文件,然后将该文件剪切并粘贴到它需要存在的文件夹中。

于 2019-10-30T23:30:29.130 回答