寻求可自动格式化生成的C#类文件的NuGet包或解决方案

嘿，我之前开发代码生成工具的时候正好碰到过完全一样的问题！手动格式化批量生成的.cs文件实在太折磨人了，后来摸索出几个靠谱的自动化方案，分享给你：

1. 用官方Roslyn SDK实现精准格式化 #

这是最推荐的方案，因为Roslyn是微软官方的C#编译分析框架，格式化逻辑和Visual Studio完全一致，还能自定义各种规则。

首先安装NuGet包：Microsoft.CodeAnalysis.CSharp.Formatting和Microsoft.CodeAnalysis.Workspaces.Common

然后可以写个简单的格式化方法：

using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Formatting;
using Microsoft.CodeAnalysis.Formatting;
using System;

public static string FormatGeneratedCSharp(string rawCode)
{
    // 解析未格式化的代码为语法树
    var syntaxTree = CSharpSyntaxTree.ParseText(rawCode);
    var rootNode = syntaxTree.GetRoot();

    // 创建临时工作区并配置格式化选项
    var workspace = new AdhocWorkspace();
    var formatOptions = workspace.Options
        .WithChangedOption(CSharpFormattingOptions.IndentationSize, 4) // 缩进4空格
        .WithChangedOption(CSharpFormattingOptions.TabSize, 4)
        .WithChangedOption(FormattingOptions.NewLine, Environment.NewLine);

    // 执行格式化
    var formattedRoot = Formatter.Format(rootNode, workspace, formatOptions);
    return formattedRoot.ToFullString();
}

你可以根据项目需求调整缩进大小、换行风格、空格规则等，完全贴合团队的代码规范。

2. 用CSharpier快速实现格式化 #

如果你觉得Roslyn的配置有点繁琐，可以试试CSharpier——一个轻量但强大的C#格式化工具，默认规则就很符合主流规范，配置简单。

安装NuGet包：CSharpier

调用代码非常简洁：

using CSharpier;
using System.Threading.Tasks;

public static async Task<string> FormatWithCSharpier(string rawCode)
{
    return await Formatter.FormatAsync(rawCode);
}

它也支持通过.csharpierrc配置文件自定义规则，比如换行长度、括号风格等。

3. 调用dotnet-format工具批量处理 #

如果你的生成流程是先把.cs文件写到磁盘，也可以直接调用官方的dotnet-format命令行工具来批量格式化。这个工具是.NET SDK自带的，不需要额外安装，只要环境里有.NET SDK就行。

在你的应用里可以通过Process调用命令：

using System.Diagnostics;

public static void FormatFilesWithDotNetFormat(string directoryPath)
{
    var process = new ProcessStartInfo
    {
        FileName = "dotnet",
        Arguments = $"format {directoryPath} --include \"*.cs\"",
        UseShellExecute = false,
        RedirectStandardOutput = true,
        CreateNoWindow = true
    };

    using var proc = Process.Start(process);
    proc.WaitForExit();
}

这种方式适合批量处理大量生成的文件，还可以配合.editorconfig文件统一团队的格式化规则。

• 不管用哪种方案，都要确保生成的代码本身是合法的C#语法，否则格式化工具可能会出错或者无法正常处理。
• 可以在项目根目录添加.editorconfig文件，定义统一的缩进、换行、空格等规则，大部分格式化工具都会自动读取这个配置，保持代码风格一致。

内容的提问来源于stack exchange，提问作者Max