在 .NET 6 中使用 dotnet format 格式化代码

我不得不承认，在 code review 的时候，我花费了很多时间来研究 C# 的代码格式问题，这是没有太大意义的工作，我应该专注于其他事情，而不是观察同事是否忘记格式化代码，或者是使用了其他不同规则的代码编辑器。

现在，我们可以使用 dotnet format 检查代码格式问题。这是 .NET 6 的新功能，.NET CLI 引入了 dotnet format 命令 ，并且它是内置的命令。

需要注意的是，如果你安装了 .NET 6 Preview 7 SDK 或更高版本，应该使用 dotnet-format 而不是 dotnet format, 否则运行命令会报错。

  如何使用？

格式化解决方案中的所有代码：

dotnet format ./solution.sln

格式化单个项目的代码

dotnet format ./src/application.csproj

验证所有代码的格式是否正确：

dotnet format --verify-no-changes

格式化 src 和 tests 目录中的所有代码，并排除 src/submodule-a 目录的代码：

dotnet format --include ./src/ ./tests/ --exclude ./src/submodule-a/

格式化并输出详细信息

dotnet-format -v diag

格式化并记录报告到文件

dotnet format --report ./report.json

更多 dotnet-format 的信息，可以查看下面的链接

https://github.com/dotnet/format