🔥关注墨瑾轩，带你探索编程的奥秘！🚀
🔥超萌技术攻略，轻松晋级编程高手🚀
🔥技术宝库已备好，就等你来挖掘🚀
🔥订阅墨瑾轩，智趣学习不孤单🚀
🔥即刻启航，编程之旅更有趣🚀

代码格式化的“六步成神法”

1. 工具选择：三大“格式化神器”对比

1.1 ReSharper：功能全面的“美颜相机”

• 特点：支持缩进、空格、命名规范等全方位格式化。
• 适用场景：团队协作、大型项目。

1.2 CSharpier：轻量级的“代码整形仪”

• 特点：基于Roslyn，命令行一键格式化。
• 适用场景：快速修复、CI/CD集成。

1.3 CodeMaid：清理与格式化的“瑞士军刀”

• 特点：移除冗余代码、排序using、格式化文档。
• 适用场景：代码清理、遗留项目维护。

---

2. 安装与配置：三步搞定工具链

2.1 安装ReSharper（Visual Studio）

# 通过Visual Studio Marketplace安装ReSharper
# 安装后重启Visual Studio

2.2 安装CSharpier（全局工具）

# 安装CSharpier全局工具
dotnet tool install --global csharpier

# 格式化指定文件
csharpier ./src/Program.cs

# 格式化整个项目
csharpier ./src/

2.3 安装CodeMaid（Visual Studio扩展）

# 通过Visual Studio Marketplace安装CodeMaid
# 安装后右键代码文件 → CodeMaid → Clean Document

---

3. 自动化流程：从“手动格式化”到“一键美化”

3.1 ReSharper自动格式化

// 原始代码（缩进混乱）
public class Program {
    static void Main ( ) {
        var  x  = 10 ; // 未缩进
        if ( x  > 5 )  Console . WriteLine ( "Hello" ) ; // 括号未对齐
    }
}

// ReSharper操作：
// 1. 全局快捷键：Ctrl + E, Ctrl + F → 格式化整个文件
// 2. 自定义规则：ReSharper → Options → Code Editing → C# → Formatting → Spaces → 在“Before open brace”中选择“Method body”

// 修复后：
public class Program {
    static void Main ( ) {
        var  x  = 10 ;
        if ( x  > 5 )
            Console . WriteLine ( "Hello" ) ;
    }
}

🌟 代码解析：

• Ctrl + E, Ctrl + F：一键格式化文件。
• 自定义规则：通过ReSharper设置统一团队风格。

---

4. 自定义规则：打造“团队专属风格”

4.1 使用.editorconfig配置格式规则

# 创建.editorconfig文件（根目录）
root = true

# C# 风格规则
[*.cs]
indent_style = space
indent_size = 4
new_line_between_type_and_members = true

# 自定义命名规范
[csharpspecific]
dotnet_naming_rule.pascal_case_for_classes.symbols = *Class
dotnet_naming_rule.pascal_case_for_classes.style = pascal_case

4.2 示例：强制PascalCase命名

// 原始代码（命名混乱）
public class userprofile { }

// 修复后（ReSharper自动修正）
public class UserProfile { }

🌟 代码解析：

• .editorconfig：统一团队代码风格。
• PascalCase：类名首字母大写，符合C#规范。

---

5. CI/CD集成：让格式化成为“团队纪律”

5.1 GitHub Actions自动格式化

# .github/workflows/format.yml
name: Format Code

on: [push, pull_request]

jobs:
  format:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3

      - name: Install CSharpier
        run: dotnet tool install --global csharpier

      - name: Format code
        run: csharpier --check ./src/

      - name: Commit changes (if needed)
        run: |
          git config --global user.name "GitHub Actions"
          git config --global user.email "actions@github.com"
          git add .
          git commit -m "Auto format code" || echo "No changes to commit"
          git push

🌟 效果：

• 每次提交自动格式化，确保代码风格一致。
• 格式化失败则构建失败，强制团队遵守规范。

---

6. 高级技巧：Roslyn自定义规则

6.1 创建自定义代码分析器

// MyAnalyzer.cs
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.Diagnostics;

[DiagnosticAnalyzer(LanguageNames.CSharp)]
public class NoMagicNumbersAnalyzer : DiagnosticAnalyzer
{
    public const string DiagnosticId = "NoMagicNumbers";

    private static readonly DiagnosticDescriptor Rule = new DiagnosticDescriptor(
        DiagnosticId,
        "Magic numbers are not allowed",
        "Magic number '{0}' found. Replace with a named constant.",
        "Design",
        DiagnosticSeverity.Error,
        isEnabledByDefault: true);

    public override void Initialize(AnalysisContext context)
    {
        context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
        context.EnableConcurrentExecution = true;
        context.RegisterSyntaxNodeAction(AnalyzeLiteralExpression, SyntaxKind.NumericLiteralExpression);
    }

    private void AnalyzeLiteralExpression(SyntaxNodeAnalysisContext context)
    {
        var literal = (LiteralExpressionSyntax)context.Node;
        if (literal.Token.Value is int value && value != 0)
        {
            var diagnostic = Diagnostic.Create(Rule, literal.GetLocation(), value);
            context.ReportDiagnostic(diagnostic);
        }
    }
}

6.2 示例：禁止魔法数字

// 原始代码（魔法数字）
var result = 10 * 2; // 报错：Magic number '10' found

// 修复后（使用常量）
const int MaxValue = 10;
var result = MaxValue * 2;

🌟 代码解析：

• NoMagicNumbersAnalyzer：检测并禁止魔法数字。
• Diagnostic：自定义错误提示，强制使用常量。

---

常见问题：避坑指南来了！

❌ 问题1：格式化后代码报错？

原因：工具规则冲突或代码本身有错误。
解决方案：先修复代码逻辑，再运行格式化工具。

❌ 问题2：团队成员不遵守格式规范？

原因：未统一配置或未集成CI/CD。
解决方案：强制使用.editorconfig + GitHub Actions自动格式化。

❌ 问题3：CSharpier格式化不生效？

原因：未正确安装或路径配置错误。
解决方案：检查全局工具是否安装成功，路径是否正确。

---

代码格式化的“魔法配方”总结

在这篇文章中，我们通过 6个核心步骤，手把手教你打造一个高效的C#代码格式化自动化流程：

1. 工具选择：ReSharper + CSharpier + CodeMaid 三大神器。
2. 安装与配置：从全局工具到IDE插件，一键搞定。
3. 自动化流程：CI/CD集成，让格式化成为团队纪律。
4. 自定义规则：.editorconfig + Roslyn规则，打造团队专属风格。
5. 高级技巧：自定义分析器，杜绝魔法数字等坏味道。
6. 常见问题：避坑指南，确保流程顺畅运行。

---