如何自动为EF Core迁移文件添加//<auto-generated />注释？

可以通过自定义EF Core的迁移代码生成器实现自动添加注释，无需手动修改文件。具体步骤如下：

1. 创建自定义迁移代码生成器 #

继承EF Core内置的CSharpMigrationsGenerator，重写生成代码的方法，在输出代码开头插入// <auto-generated />注释：

using Microsoft.EntityFrameworkCore.Migrations.Design;
using Microsoft.EntityFrameworkCore.Migrations.Design.Internal;
using System.Collections.Generic;

public class AutoGenMigrationsGenerator : CSharpMigrationsGenerator
{
    public AutoGenMigrationsGenerator(MigrationsGeneratorDependencies dependencies)
        : base(dependencies)
    {
    }

    public override string Generate(string migrationId, IReadOnlyList<MigrationOperation> upOperations, IReadOnlyList<MigrationOperation> downOperations, string @namespace, string className)
    {
        // 调用基类生成原始迁移代码
        var originalCode = base.Generate(migrationId, upOperations, downOperations, @namespace, className);
        // 在代码最开头插入自动生成注释
        var autoGenHeader = "// <auto-generated />\n";
        return autoGenHeader + originalCode;
    }
}

2. 注册自定义生成器 #

在你的DbContext类的OnConfiguring方法中，替换默认的迁移生成器服务为自定义实现：

protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
    optionsBuilder
        // 其他数据库连接等配置
        .ReplaceService<IMigrationsGenerator, AutoGenMigrationsGenerator>();
}

3. 验证效果 #

执行Add-Migration（Package Manager Console）或dotnet ef migrations add（CLI）命令生成新迁移时，生成的.cs文件开头会自动带上// <auto-generated />注释，IDE会自动忽略该文件的代码样式检查。

注意事项 #

• 确保项目已安装Microsoft.EntityFrameworkCore.Design NuGet包（版本需与EF Core主版本一致），否则会找不到相关依赖类。
• 若使用.NET 6+顶级语句项目，需确保DbContext的服务替换逻辑正确执行。

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