CA2025 Analyzer documentation #46051
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gewarren
reviewed
May 9, 2025
There was a problem hiding this comment.
Can you add this to the TOC file on this line?
| author: steveberdy | ||
| dev_langs: | ||
| - CSharp | ||
| - VB |
There was a problem hiding this comment.
Suggested change
| - VB |
...since you don't have a VB example, this isn't necessary.
|
|
||
| ## Rule description | ||
|
|
||
| Unawaited tasks that use `IDisposable` instances may use those instances long after they have been disposed. Ensure tasks using those instances are completed before the instances are disposed. |
There was a problem hiding this comment.
Suggested change
| Unawaited tasks that use `IDisposable` instances may use those instances long after they have been disposed. Ensure tasks using those instances are completed before the instances are disposed. | |
| Unawaited tasks that use `IDisposable` instances might use those instances long after they've been disposed. Ensure tasks using those instances are completed before the instances are disposed. |
|
|
||
| ## Examples | ||
|
|
||
| The following code snippets (and their VB equivalents) are violations of CA2025: |
There was a problem hiding this comment.
Suggested change
| The following code snippets (and their VB equivalents) are violations of CA2025: | |
| The following code snippets (and their Visual Basic equivalents) are violations of CA2025: |
| ```csharp | ||
| public Task DoSomethingAsync() | ||
| { | ||
| // Using statements and using blocks can both be violations |
There was a problem hiding this comment.
Suggested change
| // Using statements and using blocks can both be violations | |
| // Using statements and using blocks can both be violations. |
| var task = DoSomethingInternalAsync(disposable); | ||
| // More code here | ||
| dispose.Dispose(); | ||
| // It's a violation if arguments are disposed before the task is awaited |
There was a problem hiding this comment.
Suggested change
| // It's a violation if arguments are disposed before the task is awaited | |
| // It's a violation if arguments are disposed before the task is awaited. |
| { | ||
| var disposable = new DisposableThing(); | ||
| var task = DoSomethingInternalAsync(disposable); | ||
| // More code here |
There was a problem hiding this comment.
Suggested change
| // More code here | |
| // More code here. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Hey team, it's been a while! Here's documentation for another analyzer.
Analyzer PR here (already merged): dotnet/roslyn-analyzers#7549
Internal previews