用途:在可信的 .NET 项目中,使用所选 .NET SDK 自带的 dotnet format 命令格式化或校验代码,遵循仓库既有的格式化责任与风格配置,不引入新的个人偏好。
主要能力:可分别处理 whitespace(缩进、空格、行尾)、style(内置 .NET 代码风格诊断)、analyzers(可修复的非风格分析器诊断),也可不带子命令运行全部适用表面;支持 --verify-no-changes 做只读校验,--include/--exclude 限定工作区相对路径范围,--diagnostics 按规则 ID 缩小修复范围,--no-restore 在依赖已还原时跳过还原。
使用方式:先阅读最近的 AGENTS.md、global.json、解决方案/项目文件、.editorconfig 及 Git 状态,确认要加载的可信工作区;判断请求是只读验证还是允许应用修复,评审、解释或诊断类请求不应运行会修改文件的命令。格式化前保留现有改动,范围不确定时先用 --verify-no-changes 或窄的 --include 列表。修改运行后检查 git diff --stat、代表性差异、行尾和每个变更文件;若范围意外扩大就停止并收窄命令,不得丢弃用户已有改动。之后重新用 --verify-no-changes 校验,若应用了分析器修复,还需构建并运行相关测试。
限制:.editorconfig 与现有 MSBuild 分析器配置是唯一依据,除非用户要求,不添加任意风格模板;生成文件保持排除,除非仓库明确拥有并格式化它们;格式化进程成功不能证明所有诊断都有自动修复,需查看输出或 JSON 报告,并以构建/分析器结果作为最终证据;当存在 CSharpier、ReSharper 清理或其他格式化工具时,需保持职责边界明确。详细命令与配置参考见 references/commands.md 与 references/config.md。