Visual Studio代码样式定义

1、通过EditorConfig文件设置代码风格

 适用环境：Visual Studio for Windows

• 每个项目代码样式设置可以使用EditorConfig文件进行定义，也可以在Visual Studio中的文本编辑器选项页上进行设置。
• 本文重点介绍EditorConfig文件的方式，EditorConfig文件与代码库相关，并不是与Visual Studio个人账户相关。另外，EditorConfig文件的设置优先级高于上述的选项中的代码样式设置。所以，当需要对项目的所有参与者强制执行编码风格时，就要使用EditorConfig文件。
• 在定义EditorConfig文件时，可以通过手动创建和补充;也可以通过选项页进行配置，具体操作可通过工具=》选项=》文本编辑器=》C#=》代码样式=》生成，点击生成就会自动根据设置生成EditorConfig文件。如下图所示：

2、通过选项对话框设置样式

        在该窗口中设置的风格仅适用于Visual Studio的个人账户，不与特定项目或代码库相关。此外，这些设置不会在构建时强制执行，包括在CI构建中。如果希望将代码样式首选项与项目关联，并在构建期间强制执行这些样式，需要在与项目关联的EditorConfig文件中指定首选项。

        对于窗口中每个代码样式设置，可以通过每行的“首选项”和“严重性”下的菜单选项来分别指定。“严重性”的选项有“仅重构”、“建议”、“警告”、“错误”。如果想为某个代码样式启用（快速操作）快速修复代码问题或改进代码自动化建议，请确保“严重性”选择为除“仅重构”之外的其他选项。当代码不符合“首选项”所选择的样式时，则会出现“快速操作”灯泡、错误灯泡、螺丝刀灯泡，此时可以在相关灯泡建议中选择一个选项，自动将代码重写为首选样式。

3、在构建时强制执行代码样式

        从Visual Studio2019-16.8版本开始，可以在所有.Net项目的构建中强制执行.Net编码约定，进而在构建时，.Net代码风格若不符合代码样式的约定，将以带有“IDE”前缀的警告或错误进行显示。通过使用代码样式能够保证在代码库中一致的代码风格。

4、使用代码样式

        对于C#代码文件，在Visual Studio编辑器的底部有一个代码清理按钮，快捷键Ctrl+K,Ctrl+E，用于应用EditorConfig文件或代码样式选项配置的代码样式。如果项目存在EditorConfig文件，那么将被优先考虑。
另外，在运行代码清理扫帚的图标旁边的展开箭头，选择配置代码清理就可以打开相应配置窗口，选择想应用的代码样式文件，如下图所示：

        配置完代码清理后，可以单击扫帚图标或按Ctrl+K,Ctrl+E来运行代码清理。也可以在整个解决方案或项目中运行代码清理，操作方法是在解决方案资源管理器中右键单击项目或解决方案名称，选择“分析和代码清理”，然后选择“运行代码清理”。
如果希望每次保存文件时都应用代码样式设置，可通过选项=》文本编辑器=》代码清理，勾选“保存时运行代码清理配置文件”即可。 

英文地址：https://learn.microsoft.com/en-us/visualstudio/ide/code-styles-and-code-cleanup?view=vs-2022