【文章推荐】C# 代码规范最佳实践

[gaufung]

https://blog.jetbrains.com/dotnet/2024/06/18/code-style-for-better-productivity-tips-and-tools-from-the-metalama-team/

[gaufung]

一致性的 C# 代码有两个作用

1. 保证代码更加容易阅读，因为一个代码被阅读的次数肯定大于编写的次数
2. 统一的代码规范可以很方便合作，比如代码合并

那个统一代码规范的最佳实践是步骤包含哪些？

• 配置 IDE： 比如 .editorconfig 文件
• 配置代码整洁：当配置完代码格式化偏好，可以通过工作自动化格式代码。不过要注意这个过程并不是 100% 正确，需要非常小心
• 报告违反风格的代码：在 C# 工程中，可以让这些违反格式的代码作为编译的 warning. 在 .editorconfig 文件的中配置如下 dotnet_style_qualification_for_event = true:warning, 同时在 csproj 文件中配置 <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
• 进一步提高代码规范：在 C# 社区中，有很多开源工作可以帮助我们让代码规范更上一层楼。