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

Standard documentation fix and perhaps analyzer. #2748

Open
JohanLarsson opened this issue Aug 1, 2018 · 3 comments
Open

Standard documentation fix and perhaps analyzer. #2748

JohanLarsson opened this issue Aug 1, 2018 · 3 comments

Comments

@JohanLarsson
Copy link

Generate standard document comments.
Examples:
For:

  • Parameter of type CancellationToken
  • Backing field for a WPF dependency property.
  • Attached property Get & Set methods
  • ...

There is also an analyzer opportunity that checks that things that have a standard documentation are using it.

@sharwell
Copy link
Member

sharwell commented Aug 1, 2018

Here's the standard documentation for a CancellationToken cancellationToken parameter of an asynchronous method:

<param name="cancellationToken">The <see cref="CancellationToken"/> that the task will observe.</param>

We don't enforce this (like we do for standard constructor text), but it would be acceptable to generate it if/when missing.

@JohanLarsson
Copy link
Author

We should probably create an issue per case that comes up. So it can be discussed and used for tracking commits. The list is probably pretty long so one thread would be messy, wrote this to check what other people think.

Where does the standard documentation for CancellationToken come from btw?

@sharwell
Copy link
Member

sharwell commented Aug 1, 2018

I hate to open the door for an unknown number of proposals (😆) but here's one from docs.microsoft.com:

The token to monitor for cancellation requests.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants