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

Clarified the use of var (AV1520) and supplemented AV1707 (names) #252

Merged
merged 3 commits into from
Feb 10, 2022
Merged

Clarified the use of var (AV1520) and supplemented AV1707 (names) #252

merged 3 commits into from
Feb 10, 2022

Conversation

bkoelman
Copy link
Contributor

@bkoelman bkoelman commented Feb 8, 2022

AV1520
This PR does not fundamentally change the point of view around var usage. 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 var when definitely obvious and falling back to full type names when unsure or unable to determine. This means that treating var usage manually on a case-by-case basis (effectively allowing var in more cases than in the automated case) yields more readable code. But at the expense of recurring subjective discussions around var usage 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.

@bkoelman bkoelman mentioned this pull request Feb 8, 2022
@dennisdoomen
Copy link
Owner

Time to merge?

@bkoelman
Copy link
Contributor Author

bkoelman commented Feb 9, 2022

Yes

@dennisdoomen dennisdoomen merged commit f720261 into dennisdoomen:master Feb 10, 2022
@bkoelman bkoelman deleted the av1520-var branch February 10, 2022 07:52
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

Successfully merging this pull request may close these issues.

2 participants