Attribute to add comments on the table and columns

[ralmsdeveloper]

• Resolve: Data annotation for configuring comments #20569

[ralmsdeveloper]

Could anyone on the team tell me if this would be a good way to go?

/cc: @ajcvickers

[lajones]

Generally this is the right approach. But we don't think you should use the existing DataAnnotations DescriptionAttribute: that would cause anyone who is currently using that to have these table / column comments show up - which is probably not what they intended. Instead could you create a new EntityFrameworkCore attribute similar to KeylessAttribute please?

You'd probably want this attribute to apply to Class, Property and Field (and could you add some tests for this latter as well please?).

But generally looking good. Thanks!

[ralmsdeveloper]

Thanks @lajones for your comments, but we have a small detail, the idea of ​​following the KeylessAttribute, I feel comfortable, is that maybe when designing an architecture people may not want to dependence on EFCore in their domain.

But I will continue with your suggestion.

[ralmsdeveloper]

@lajones

We should use:
CommentAttribute or DescriptionAttribute

What are your thoughts on that?

[lajones]

@ralmsdeveloper Personally I prefer CommentAttribute as it is more specific to what you're actually trying to achieve.

[ralmsdeveloper]

@lajones I hope this time I got it right :)

[lajones]

Two minor changes and it'll all be good.

[lajones]

Merged. Thanks for your contribution, @ralmsdeveloper

[Seanxwy]

Is it ready to use?

[lajones]

@yuanxiongwei Yes. It's available in the latest preview, 5.

[ralmsdeveloper]

@ajcvickers all right?
Should this be documented anywhere?

[roji]

@ralmsdeveloper opened dotnet/EntityFramework.Docs#2892