Modify S3247: Improve description and update example #4019
Merged
Conversation
This file contains 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
mary-georgiou-sonarsource
approved these changes
Jul 1, 2024
rules/S3247/csharp/rule.adoc
Outdated
| @@ -1,11 +1,21 @@ | |||
| == Why is this an issue? | |||
|
|
|||
| Because the ``++is++`` operator performs a cast if the object is not null, using ``++is++`` to check type and then casting the same argument to that type, necessarily performs two casts. The same result can be achieved more efficiently with a single cast using ``++as++``, followed by a null-check. | |||
| In C#, the https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/operators/type-testing-and-cast#is-operator[`is` type testing operator] can be used to check if the run-time type of an object is compatible with a given type. If the check is successful, it means the code performed a cast. Performing another cast following the check result into a duplicate cast. | |||
There was a problem hiding this comment.
Suggested change
| In C#, the https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/operators/type-testing-and-cast#is-operator[`is` type testing operator] can be used to check if the run-time type of an object is compatible with a given type. If the check is successful, it means the code performed a cast. Performing another cast following the check result into a duplicate cast. | |
| In C#, the https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/operators/type-testing-and-cast#is-operator[`is` type testing operator] can be used to check if the run-time type of an object is compatible with a given type. If the object is not null, then the `is` operator performs a cast, and so performing another cast following the check result is redundant. |
rules/S3247/rspecator.adoc
Outdated
|
|
||
| === Message | ||
|
|
||
| Primary: Replace this type-check-and-cast sequence with an "as" and a null check. |
There was a problem hiding this comment.
Suggested change
| Primary: Replace this type-check-and-cast sequence with an "as" and a null check. | |
| Primary: "Replace this type-check-and-cast sequence to use pattern matching." |
|
|
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.
RSPEC update for SonarSource/sonar-dotnet#2120