C# Debate: When Should You Use var?
C# 3 added the keyword "var". This allows for local type inference when the compiler can unequivocally determine what type the variable should be. There is, however, some debate as to when it should be used.
- It induces better naming for local variables.
- It induces better API.
- It induces variable initialization.
- It removes code noise
- It doesn't require the using directive.
Dare Obasanjo of RSS Bandit does not agree. He wrote a response to Ryzhenkov's position after seeing what he thought of as detrimental changes to his open source project. He counters with,
It's interesting how not only are almost all of these "benefits" mainly stylistic but how they contradict each other. For example, the claim that it leads to "better naming for local variables" really means it compels developers to use LONGER HUNGARIAN STYLE VARIABLE NAMES. Funny enough, these long variable names add more noise to the code overall since they show up everywhere the variable is used compared to a single type name showing up when the variable is declared. The argument that it leads to "better API" is another variation of this theme since it argues that if you are compelled to use LONGER MORE DESCRIPTIVE PROPERTY NAMES (e.g. XmlNode.XmlNodeName instead of XmlNode.Name) then this is an improvement. Someone should inform the ReSharper folks that encoding type information in variable names sucks, that's why we're using a strongly typed programming language like C# in the first place.
One more thing, the claim that it encourages variable initialization is weird given that the C# compiler already enforces that. More importantly, the common scenario of initializing a variable to null before it is used isn't supported by the var keyword.
Dare backs up his claim with this line from the official C# Language Reference,
Overuse of var can make source code less readable for others. It is recommended to use var only when it is necessary, that is, when the variable will be used to store an anonymous type or a collection of anonymous types.
The complaint that var reduces readability is not shared by everyone. Arnon Rotem-Gal-Oz writes,
As for the code readability claim, I prefer to focus on stronger methods like keeping methods short, meaningful method and variable names and supporting tests (which can actually help you understand how the code behaves...). Not to mention that, if you really really need that, resharper will tell you the type if you put the mouse over the var keyword ;)
Chris Sutton seems to go further and implies that the type really doesn't matter.
Then the suggestion came up that you should only use var when you don’t know the type. Here is where I differ in opinion and usage. Look at the following snippet
var procs = from p in ServiceController.GetServices()
where p.Status == ServiceControllerStatus.Running
procs is certainly IEnumerable
but it doesn’t matter to me. I primarily care that procs is a list and that the individual items in the list have a Property called ServiceName. The underlying type is important to the compiler, but the people that have to read code aren’t compilers right?
I would say use var wherever you can use it
You use var when no one cares about the type.
- In LINQ queries
- IN FOREACH LOOPS:foreach( var blah in someCollection), that one is big
-Dictionnaries. The difference between a dictionnary that cares about case or doesn't depends on the comparer. People who look just at the type will miss that. Using var in that case force people to look at the initialization.
-When using datasets/dataadapter, especially typed ones... the declaration gets rediculous and is just noise.
There's more. You shouldn't use var everywhere, that reduces the information the code gives to a reader just by looking at it (without mouse overs). But the above scenarios clearly benifit from it. When you don't know the type and only the initialization matters (like foreach and linq), or when declaration just adds visual noise.
Don't go using var blah = 12; that just takes away from the intention. Is that an int? A float? I know its an int, but I don't know if it was your intention...
Re: I would say use var wherever you can use it
Re: I would say use var wherever you can use it
When to use type inference
yes of course, var is type safe but what is our gain in using it everywhere?
compiler acts like this: when sees the var keyword it tries to find the type of variable based on the value assigned to it, this means that we can't assign a value that compiler can't determine it's type, and this results to:
We can't use var when initializing a variable to null, cause compiler can't determine it's type.
OK lets see another case, suppose we have the following line of code:
var amount = 13;
Now what is amount? int16, int32 or int64?
or another example:
var tax = taxCalculator.GetTax(amount);
Now what is the type of tax???
These are really confusing and it's not a good practice to use type inference in these situations.
Or something like this:
var firstName = "shirvan";
What is our gain using var instead of string??? i think nothing.
In DRY case I'm agree that repeating is unnecessary in variable declaration and in my opinion the right side type declaration is unnecessary and redundant, but to get rid of this redundancy c# compiler should take the responsibility and enables this feature(maybe in future releases) instead of using var and sacrificing readability.
The var keyword is very cool feature in c# 3.0, I'm also a big fan of Intelligent laziness and less typing but i think it's not applicable here and we shouldn't use type inference everywhere in our code, the right place to use it is when dealing with anonymous types or a collection of anonymous types.
Re: When to use type inference
NotificationClient client = new NotificationClient();
NotificationRequest noteReq = new NotificationRequest();
NotificationResponse noteResp = new NotificationResponse();
1. That's redundant as heck and adds noise.
2. It's not as visually aligned and tidy looking as this is:
var client = new NotificationClient();
var noteReq = new NotificationRequest();
var noteResp = new NotificationResponse();
Re: When to use type inference
I think we should use var moderately. It's like alcohol here in Brazil: "Aprecie com moderação" ("Enjoy it moderately").
In cases of variable initialization, it's great. Assigning a value which has an explicit type (like int or string) is good either.
But use it in a variable which receives a response from a method is not good at all, like:
var x = DoSomethingAndReturnSomethingElse("SomeValue");
Well... Like almost everything: enjoy it moderately!
Visual Studio ALM in a nutshell - blog.ricardoserradas.net
But, that has always been my point...
Precisely! And isn't it a lot simpler and straight forward to know that the object has a particular property or implements and particular interface if you actually know what type the object is?!?
I honestly don't get the argument, "I don't care what it is, I just need to know what it does and how it works." To me, the need to know how it works and functions is greatly enhanced by knowing what it is.
I have never, ever, ever once said, "Wow...these variable names are just too long and it makes too much 'noise' having all this information up front..." I just do not get it. At all. As a programmer, I instantly and immediately want to know what I have in front of me so that I can know how to utilize it. Spending the first 1/3 of my time analyzing what type ends up in var when I could be designing and developing just drives me batty.
To me, it is only easier for the original coder. Since the lion's majority of any code cost is in maintenance, this is a false savings. You are driving up maintenance cost in dollars saving a few pennies in reducing 'noise' or 'typing'. My own two cents anyway.
Shane Hastie on Distributed Agile Teams, Product Ownership and the Agile Manifesto Translation Program
Shane Hastie Apr 17, 2015