C# EditorConfig使用教程 代码风格统一技巧

必须放在解决方案根目录（.sln所在目录），因VS和Rider默认只向上查找一级到首个.sln或.csproj同级的.editorconfig；放子项目目录会导致父项目或共享库被忽略。

EditorConfig 文件该放项目根目录还是解决方案根目录

必须放在解决方案根目录（.sln 所在目录），否则 Visual Studio 和 Rider 在多项目解决方案中可能只对部分项目生效。C# 编译器本身不读取 .editorconfig，真正起作用的是 IDE 和 Roslyn 分析器，而它们默认只向上查找一级到第一个 .sln 或 .csproj 同级的 .editorconfig。若放在子项目目录下，父项目或共享库很可能被忽略。

• 验证方式：在 VS 中右键任意 .cs 文件 → “快速操作和重构” → 若看到“使用 EditorConfig 规则格式化”选项，说明已识别
• 推荐结构：

  .sln
  .editorconfig
  src/
    ProjectA/
      ProjectA.csproj
    ProjectB/
      ProjectB.csproj
  

• 不要在每个 csproj 目录下重复放一份 —— 容易不同步、覆盖失效

哪些 C# 风格规则必须显式配置而非依赖默认值

Visual Studio 的“选项 → 文本编辑器 → C# → 代码样式”里显示的默认值 ≠ EditorConfig 实际行为。很多关键风格项（如 var 使用、括号位置、空格）必须在 .editorconfig 中明确写出来，否则团队成员开启/关闭某项“自动格式化”时行为不一致。

• 必配项示例：

  [*.cs]
  csharp_style_var_for_built_in_types = true:suggestion
  csharp_style_var_when_type_is_apparent = true:suggestion
  csharp_new_line_before_open_brace = all
  csharp_space_after_cast = true
  csharp_preserve_single_line_statements = false
  

• suggestion 级别会被 Roslyn 分析器标记为波浪线，error 会直接报错（CI 中可配合 dotnet build /warnaserror）
• 注意 csharp_style_* 和 dotnet_style_* 前缀混用会导致规则被忽略 —— C# 场景统一用 csharp_*

VS 和 Rider 对 .editorconfig 的支持差异点

Rider 默认严格遵循 .editorconfig，而 Visual Studio 2019+ 虽已支持，但部分旧版插件（如 Resharper 2021.3 之前）会覆盖 EditorConfig 设置，导致“明明写了却没生效”。

• 常见冲突点：csharp_indent_case_contents_when_block 在 VS 中需同时开启“选项 → 文本编辑器 → C# → 格式设置 → 缩进”里的对应开关，否则被忽略
• Rider 用户需确认：Settings → Editor → Code Style → C# → “Use EditorConfig files” 已勾选，且未勾选“Override code style from EditorConfig”
• CI 构建时（如 GitHub Actions），dotnet format 默认读取 .editorconfig，但需指定 --include **/*.cs，否则跳过隐藏文件夹（如 obj/）

如何让 EditorConfig 强制约束 PR 提交前的代码风格

靠人手动格式化不可靠，必须接入 pre-commit 或 CI。EditorConfig 本身只是声明规则，不带执行能力 —— 它需要搭配 dotnet format 或 clang-format（不推荐）等工具落地。

• 本地 Git Hook 示例（使用 husky + dotnet-format）：

  npm install husky --save-dev
  npx husky add .husky/pre-commit "dotnet format --verify-no-changes --include **/*.cs"

• GitHub Actions 中校验：

  - name: Check formatting
    run: dotnet format --verify-no-changes --include '**/*.cs'
  

• 注意：--verify-no-changes 在有差异时返回非零退出码，CI 即失败；但需确保运行环境已安装匹配版本的 dotnet-format CLI 工具（不是 SDK 自带的）

实际最难的不是写规则，而是让所有成员的 IDE 不再“自作主张”地覆盖 .editorconfig —— 特别是 Resharper 的“Code Cleanup”模板、VS 的“保存时格式化”开关、Rider 的“On-the-fly formatting”，这些都得关掉或设为仅响应 EditorConfig。