dotnet format

  • 项目

本文适用于：✔️ .NET 6.x SDK 及更高版本

名称

dotnet format - 设置代码格式以匹配 editorconfig 设置。

摘要

dotnet format [<PROJECT | SOLUTION>] [command] [options]

dotnet format -h|--help

说明

dotnet format 是一种代码格式化程序，它将样式首选项应用于项目或解决方案。 将从 .editorconfig 文件中读取首选项（如果存在），否则将使用一组默认首选项。 有关详细信息，请查看 EditorConfig 文档。

参数

PROJECT | SOLUTION

用于运行代码格式化的 MSBuild 项目或解决方案。 如果未指定项目或解决方案文件，MSBuild 会在当前工作目录中搜索文件扩展名以 proj 或 sln 结尾的文件并使用该文件。

选项

要成功执行 dotnet format 命令，下面的选项都不是必需的，但是可以用来进一步自定义格式化的内容和需要遵循的规则。

  • --diagnostics <DIAGNOSTICS>

    以空格分隔的诊断 ID 列表，在修复代码样式或第三方问题时用作筛选器。 默认值为 .editorconfig 文件中列出的 ID。 有关可以指定的内置分析器规则 ID 的列表，请参阅用于代码分析样式规则的 ID 列表。

  • --severity

    要修复的诊断的最低严重性。 允许使用的值为 info、warn 和 error。 默认值为 warn。

  • --no-restore

    请勿在设置格式之前执行隐式还原。 默认设置是执行隐式还原。

  • --verify-no-changes

    验证不会执行任何格式更改。 如果任何文件已设置格式，则以非零退出代码终止。

  • --include <INCLUDE>

    要包含在格式设置中的以空格分隔的相关文件或文件夹路径列表。 默认为解决方案或项目中的所有文件。

  • --exclude <EXCLUDE>

    要从格式设置中排除的以空格分隔的相关文件或文件夹路径列表。 默认值为 none。

  • --include-generated

    设置 SDK 生成的文件的格式。

  • -v|--verbosity <LEVEL>

    设置详细程度。 允许使用的值为 q[uiet]、m[inimal]、n[ormal]、d[etailed] 和 diag[nostic]。 默认值是 m[inimal]。

  • --binarylog <BINARY-LOG-PATH>

    将所有项目或解决方案加载信息记录到二进制日志文件中。

  • --report <REPORT-PATH>

    在 <REPORT_PATH> 指定的目录中生成 JSON 报告。

  • -h|--help

    显示帮助和使用情况信息

子命令

空格

dotnet format whitespace - 设置代码格式以匹配空白的 editorconfig 设置。

说明

子 dotnet format whitespace 命令仅运行与空格格式关联的格式设置规则。 有关可以在 .editorconfig 文件中指定的可能格式设置选项的完整列表，请参阅 C# 格式设置选项。

选项

  • --folder

    将 <PROJECT | SOLUTION> 参数视为代码文件的简单文件夹的路径。

Style

dotnet format style - 设置代码格式以匹配代码样式的 EditorConfig 设置。

说明

子 dotnet format style 命令仅运行与代码样式格式关联的格式设置规则。 有关可以在 editorconfig 文件中指定的格式设置选项的完整列表，请参阅代码样式规则。

选项

  • --diagnostics <DIAGNOSTICS>

    以空格分隔的诊断 ID 列表，在修复代码样式或第三方问题时用作筛选器。 默认值为 .editorconfig 文件中列出的 ID。 有关可以指定的内置分析器规则 ID 的列表，请参阅用于代码分析样式规则的 ID 列表。

  • --severity

    要修复的诊断的最低严重性。 允许使用的值为 info、warn 和 error。 默认值为 warn

分析器

dotnet format analyzers - 设置代码格式以匹配分析器的 editorconfig 设置。

说明

子 dotnet format analyzers 命令仅运行与分析器关联的格式设置规则。 有关可在 editorconfig 文件中指定的分析器规则的列表，请参阅代码样式规则。

选项

  • --diagnostics <DIAGNOSTICS>

    以空格分隔的诊断 ID 列表，在修复代码样式或第三方问题时用作筛选器。 默认值为 .editorconfig 文件中列出的 ID。 有关可以指定的内置分析器规则 ID 的列表，请参阅用于代码分析样式规则的 ID 列表。

  • --severity

    要修复的诊断的最低严重性。 允许使用的值为 info、warn 和 error。 默认值为 warn。

示例

  • 设置解决方案中所有代码的格式：

    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/