Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore: Clean Up XML Comments for V10 #3499

Open
iancooper opened this issue Feb 4, 2025 · 0 comments
Open

Chore: Clean Up XML Comments for V10 #3499

iancooper opened this issue Feb 4, 2025 · 0 comments

Comments

@iancooper
Copy link
Member

Is your feature request related to a problem? Please describe.
Our style is to document public members of classes and public interfaces with XML comments /// Those comments produce Intellisense.

Describe the solution you'd like
Provide clear help to users of our APIs on how to use them successfully. Some notes on fixes:

  • Summary should summarize expected behavior
  • Remarks should indicate notes to maintainers or users
  • Params and Return values should use to indicate types where appropriate

We should avoid just repeating the name, and provide more helpful hints

Describe alternatives you've considered
The alternative is not to document, but Intellisense remains helpful

@iancooper iancooper added V10.X v10 Allocal to a v10 release RC2 and removed v10 Allocal to a v10 release V10.X labels Mar 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant