如何为 .NET 项目自定义强制代码样式规则 #yyds干货盘点#

Posted My空格IO

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了如何为 .NET 项目自定义强制代码样式规则 #yyds干货盘点#相关的知识,希望对你有一定的参考价值。

前言

每个人都有自己的代码样式习惯:命名约定、大括号、空格、换行等。

但是,作为一个团队来说,应该使用同样的代码样式规则。这样可以有效减少编译器的警告/建议,保证阅读代码的人员理解一致。

今天我们介绍一种为单独的 .NET 项目定义代码样式设置的方式。

那就是 —— EditorConfig 文件。

Demo

在 Visual Studio 中的“解决方案资源管理器”右键选择解决方案/项目节点,在弹出菜单中选择“添加” > “新建项”。

在弹出窗口中选择“editorconfig 文件(.NET)”模板:

如何为

添加完成后会在解决方案创建“.editorconfig”文件,双击该文件即可打开配置 UI。

这里我们演示设置“在点前插入空格”(默认为false):

如何为

输入代码后,可以看到,VS 自动在点前加入了空格:

如何为

文件格式

用文本编辑器打开 .editorconfig 文件,可以看到内置了很多规则,格式如下:

[分组(支持通配符)]
配置项 = 配置值

例如,为所有 cs 文件定义的规则:

如何为

我们可以清除默认规则,根据需要创建指定规则。

比如,仅为 demo 开头的文件设置“在点前插入空格”:

[demo*.cs]
csharp_space_before_dot=true

详细规则请参看:https://docs.microsoft.com/zh-cn/dotnet/fundamentals/code-analysis/style-rules/

结论

今天, 我们介绍了 EditorConfig 文件用于为 .NET 项目自定义强制代码样式规则。

想了解更多内容,请关注我的个人公众号”My IO“

如何为

以上是关于如何为 .NET 项目自定义强制代码样式规则 #yyds干货盘点#的主要内容,如果未能解决你的问题,请参考以下文章

如何为 UIPopoverController 强制设置黑色边框

Laravel 5.4 - 如何为同一个自定义验证规则使用多个错误消息

如何为antd Select设置自定义样式?

如何为 UINavigationBar 的 styleBar 创建自定义样式?

如何为 ASP.NET MVC 2 创建自定义成员资格提供程序?

如何为 Vue.js 组件创建自定义样式属性