You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As the rate of production of XML documentation comments increases for standard library and third-party packages, we are getting close to the point where maintaining two sets of strings (one for property grid with DescriptionAttribute; and another with XML documentation comments) for every member of every package will become unsustainable.
It would be preferable to simply rely on XML documentation comments for everything, and retrieve them automatically by collecting the available XML documentation databases, together with a set of utilities for generating XPath queries. A similar strategy to how documentation URLs are extracted could be employed, by leveraging the bootstrapper context to retrieve operator package provenance, or alternatively simply probe the assembly location and look for a companion XML documentation file.
Lazy caching would almost definitely need to be considered to allow reusing documentation databases, and some kind of type converter mechanism on top of the property grid would also need to be developed to override the default mechanism using DescriptionAttribute.
The text was updated successfully, but these errors were encountered:
As the rate of production of XML documentation comments increases for standard library and third-party packages, we are getting close to the point where maintaining two sets of strings (one for property grid with
DescriptionAttribute
; and another with XML documentation comments) for every member of every package will become unsustainable.It would be preferable to simply rely on XML documentation comments for everything, and retrieve them automatically by collecting the available XML documentation databases, together with a set of utilities for generating XPath queries. A similar strategy to how documentation URLs are extracted could be employed, by leveraging the bootstrapper context to retrieve operator package provenance, or alternatively simply probe the assembly location and look for a companion XML documentation file.
Lazy caching would almost definitely need to be considered to allow reusing documentation databases, and some kind of type converter mechanism on top of the property grid would also need to be developed to override the default mechanism using
DescriptionAttribute
.The text was updated successfully, but these errors were encountered: