Clarified the use of var (AV1520) and supplemented AV1707 (names)#252
Merged
Conversation
Owner
|
Time to merge? |
Contributor
Author
|
Yes |
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
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.
AV1520
This PR does not fundamentally change the point of view around
varusage. But it makes the examples compatible with automated tooling (vanilla Visual Studio, Visual Studio with Resharper, Rider). Automation is not a requirement, but it should at least be possible (which goes for the majority of rules).Built-in types are always short, so spelling out the type name does not clutter the screen with useless information, which may happen on deeply nested generic types (
IOrderedEnumerable<IGrouping<...>>).The "when evident" mode is conservative in nature, only using
varwhen definitely obvious and falling back to full type names when unsure or unable to determine. This means that treatingvarusage manually on a case-by-case basis (effectively allowingvarin more cases than in the automated case) yields more readable code. But at the expense of recurring subjective discussions aroundvarusage in PRs, which is a tradeoff every team can make for itself.AV1707
When using
var, some developers tend to suffix each variable name with its type, which is an anti-pattern (similar to Hungarian notation). Because this manual effort deteriorates over time, similar to outdated documentation that states the obvious. When the type changes due to refactorings elsewhere, you'll need to remember to also rename the affected variables, which is often forgotten, and then the code becomes misleading. Therefore it is preferred to rely on type information that gets validated by the compiler.