Cleanup: consider converting comments on private fields into xml docs

dotnet / efcore

EF Core is a modern object-database mapper for .NET. It supports LINQ queries, change tracking, updates, and schema migrations.

https://docs.microsoft.com/ef/

MIT License

13.73k stars 3.17k forks source link

Cleanup: consider converting comments on private fields into xml docs #29852

Open maumar opened 1 year ago

maumar commented 1 year ago

... so that they pop up in intellisense

ajcvickers commented 1 year ago

Notes from triage: we will try this, but concerns are:

NuGet package size will increase
It could break the docs platform

roji commented 1 year ago

It turns out we already have a few xmldocs on private stuff, e.g. ExecutionStrategy. These don't appear in the docs (note the protected ones which do).

It's true that these are published in the docs XML included in the nuget, but I don't really see much issue with that... This is also definitely not something we should start systematically doing on everything - just case-by-case where it makes sense.