如何为 .NET 项目自定义强制代码样式规则 #yyds干货盘点#
source link: https://blog.51cto.com/MyIO/5143530
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
如何为 .NET 项目自定义强制代码样式规则 #yyds干货盘点#
原创每个人都有自己的代码样式习惯:命名约定、大括号、空格、换行等。
但是,作为一个团队来说,应该使用同样的代码样式规则。这样可以有效减少编译器的警告/建议,保证阅读代码的人员理解一致。
今天我们介绍一种为单独的 .NET 项目定义代码样式设置的方式。
那就是 —— EditorConfig 文件。
在 Visual Studio 中的“解决方案资源管理器”右键选择解决方案/项目节点,在弹出菜单中选择“添加” > “新建项”。
在弹出窗口中选择“editorconfig 文件(.NET)”模板:
添加完成后会在解决方案创建“.editorconfig”文件,双击该文件即可打开配置 UI。
这里我们演示设置“在点前插入空格”(默认为false):
输入代码后,可以看到,VS 自动在点前加入了空格:
用文本编辑器打开 .editorconfig 文件,可以看到内置了很多规则,格式如下:
{配置项} = {配置值}
例如,为所有 cs 文件定义的规则:
我们可以清除默认规则,根据需要创建指定规则。
比如,仅为 demo 开头的文件设置“在点前插入空格”:
csharp_space_before_dot=true
详细规则请参看:https://docs.microsoft.com/zh-cn/dotnet/fundamentals/code-analysis/style-rules/
今天, 我们介绍了 EditorConfig 文件用于为 .NET 项目自定义强制代码样式规则。
想了解更多内容,请关注我的个人公众号”My IO“
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK