Ef Core花里胡哨系列(6) XML注释同步到数据库注释

本文主要是介绍Ef Core花里胡哨系列(6) XML注释同步到数据库注释，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

Ef Core花里胡哨系列(6) XML注释同步到数据库注释

参考文档：C#读取注释的方法

准备读取Xml的工具类

可以根据[参考文档]获取一个简单读取注释的方法。

实现DbContext

我们通过重写OnModelCreating方法，在生成数据库表时，使用FluentApi指定对应表以及其属性的Comment即可将Xml注释转为数据库的Comment。

public class SampleDbContext : DbContext
{public SampleDbContext(DbContextOptions<SampleDbContext> options) : base(options) { }public DbSet<User> Users { get; set; }protected override void OnModelCreating(ModelBuilder modelBuilder){var xmlCommentHelper = new XmlCommentHelper();xmlCommentHelper.LoadAll();foreach (var entityType in modelBuilder.Model.GetEntityTypes()){var typeComment = xmlCommentHelper.GetTypeComment(entityType.ClrType);modelBuilder.Entity(entityType.ClrType).ToTable(t => t.HasComment(typeComment));foreach (var property in entityType.ClrType.GetProperties().Where(x => x.IsPubliclyWritable())){var propertyComment = xmlCommentHelper.GetFieldOrPropertyComment(property);modelBuilder.Entity(entityType.ClrType).Property(property.Name).HasComment(propertyComment);}}base.OnModelCreating(modelBuilder);}
}/// <summary>
/// 用户表
/// </summary>
public class User
{/// <summary>/// Id/// </summary>public Guid Id { get; set; }/// <summary>/// 姓名/// </summary>public required string Name { get; set; }/// <summary>/// 邮箱/// </summary>public required string Email { get; set; }
}