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

27

如何将编辑器配置文件中的代码约定(代码格式设置)导入Visual Studio?

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

2个回答

29

EditorConfig在Visual Studio 2017及更高版本中得到支持。

创建EditorConfig文件

如果您愿意,可以创建一个空的文本文件,并添加所需的设置。但是,Visual Studio还可以为.NET为您创建具有合理默认值的.editorconfig文件。MSDN上说:

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

  • 选择编辑器配置文件(.NET)模板,以添加一个预先填充了默认.NET代码样式、格式和命名约定的EditorConfig文件

enter image description here

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

在Visual Studio 2019中,您可以选择从当前设置创建一个EditorConfig文件。只需在选项对话框中找到Text Editor > C# > Code Style > General下的以下按钮:

enter image description here

在解决方案之间共享EditorConfig

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

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

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

如果您使用Visual Studio 2019,则建议您使用上面详细说明的从设置生成.editorconfig文件按钮,并将.editorconfig文件保存到您的解决方案文件夹中。否则,您可以创建一个临时项目,创建配置文件,然后将该文件剪切并粘贴到需要存储的文件夹中。


其他人是否可以使用他们的Visual Studio工具、选项、代码样式编辑器更新这个.editorconfig文件? - Case 303
很遗憾,但似乎无法保存从编辑器配置文件选项菜单所做的修改。 - Philippe Auriou
Resharper有生成选项,基本上它会将所有Reshaper设置导出到.editorconfig文件中。 - Rosdi Kasim
能否在不属于项目的解决方案项上使用 .editorconfig? - Luuk Krijnen
1
我在阅读这个答案之前就已经理解了它的工作原理,但我还有一个问题:对我来说,似乎我们需要为 C++C#Javascript 使用不同的 .editorconfig 文件。在解决方案级别上是否可以有多个 .editorconfig 文件,例如因为解决方案包含一个 C# 和一个 C++ 项目?(我认为这是不可能的,因为似乎 .editorconfig 文件必须具有确切的名称)。 - Binarus

-3
将.editorconfig放在所有存储库共享的基础文件夹中。
Visual Studio和VS Code将从那里为您的所有工作区选择它。
如果您使用Visual Studio默认位置克隆了代码,则公共基础文件夹将是%USERPROFILE%\source\repos\

2
“Visual Studio和VS Code将从那里为您的所有解决方案接收它,因为通常我们所有的源代码都放在%USERPROFILE%\source\repos中。”抱歉,但我认为这一点根本不准确。 - kirgod
@kirgod 这是默认的VS行为。你希望我有多准确? - carlin.scott
@NikolaMalešević 这个问题和答案是针对Visual Studio的。那么你为什么会认为大多数查看此内容的开发人员没有使用Visual Studio来克隆他们的git存储库呢? - carlin.scott
因为大多数关注这个问题的开发者来自不同背景,虽然使用 Visual Studio,但他们很可能不会将代码存储在你提到的位置。 - Nikola Malešević
@NikolaMalešević 那项调查显示,超过一半的开发者使用 Code Editor 提供的 git 接口。我猜这取决于他们所使用的编程语言的编辑器是否有良好的 git 集成。VS 有良好的 git 集成,并且可以直接从 GitHub 打开。因此,我想如果这些数据按 VS 用户进行过滤,Code Editor选项的比例应该接近100%。 - carlin.scott
显示剩余5条评论

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接