Click here to Skip to main content
15,888,803 members
Articles / Programming Languages / C# 4.0

Best Practices on Using Implicitly Typed (i.e. var ) and Explicitly Typed Variables

Rate me:
Please Sign up or sign in to vote.
2.68/5 (14 votes)
4 Nov 2009CPOL1 min read 82.4K   5   60
Best practise using var

Introduction

Leveraging the type inference is wonderful when writing code. With the arrival of ‘var’ in C# 3.0, it now allows a developer to write more relaxed code.

int i = 2 can now be written as var i = 2, without having to worry about the overhead for boxing/un-boxing.

The compiler infers the type indicated by ‘var’ from the expression used to initialize the variable, and the IL code contains the inferred type. However, it is not always the best thing to use var. While using ‘var’ can help developers to avoid all the type declarations for local variables, it has an impact on code readability. Consider invoking an overloaded method, which differs in the parameter type. If the method is invoked with parameters declared as ‘var’, it makes the code complex to understand.

Consider the following snippet:

C#
private int GetUserInput()
{
    Random r = new Random(1);
    return r.Next();
}

private int Add(int numberOne, int numberTwo)
{
    return numberOne + numberTwo;
}
private float Add(float numberOne, float numberTwo)
{
    return Convert.ToInt32(numberOne + numberTwo);
}

private void InvokeAdd()
{
    var numberOne = GetUserInput();
    var numberTwo = GetUserInput();
    //...
    var addedNumber = Add(numberOne, numberTwo); //version of ‘Add’ method is not evident
}

Which version of ‘Add’ method is invoked is not evident at the first glance, in the above snippet.
Although the best practices for using ‘var’ cannot be made generic but a little guidance can help in making a conscious choice. Below are a few thoughts on when to use or not to use ‘var’.

  1. Do use ‘var’ to:
    1. Refer anonymous types, e.g.
      C#
      var anonymousType = new { Name = "Dilbert" };
    2. Refer query expressions, e.g.
      C#
      var queryExpression = from c in customers where c.Name == "Dilbert" select c;
    3. Refer complex generic types, e.g.
      C#
      var searchList = new Dictionary<string>();
  2. Do not use ‘var’ to:
    1. Refer known types, e.g.

      C#
      var customer = new Customer(); //Do not use 
      var numberList = new int[] { 1, 2, 3, 4, 5 }; //Do not use.
    2. Refer constants, e.g.

      C#
      var i = 5; //Do not use
    3. Refer simple expression assignments, e.g.

      C#
      var count = customers.Count();//Do not use
      var customerName = customer.Name;//Do not use
    4. Refer variables where types cannot be inferred or where inferred type is not what is intended, e.g.

      C#
      IList<customer> customers = new List<customer />(); //Do not use

      Consider code readability and maintainability while making a choice between ‘var’ and explicit type.

History

  • 4th November, 2009: Initial post

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Unknown
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Comments and Discussions

 
GeneralMy vote of 1 Pin
Björn Friedrich14-Jan-11 5:05
Björn Friedrich14-Jan-11 5:05 
GeneralMy vote of 1 Pin
Richard Deeming12-Nov-09 9:00
mveRichard Deeming12-Nov-09 9:00 
General[My vote of 1] Мethodically, socially and morally incorrect Pin
Sergey Alexandrovich Kryukov9-Nov-09 6:51
mvaSergey Alexandrovich Kryukov9-Nov-09 6:51 
GeneralSuch an overreaction... Pin
CurtainDog9-Nov-09 19:45
CurtainDog9-Nov-09 19:45 
GeneralRe: Such an overreaction... Pin
Sergey Alexandrovich Kryukov10-Nov-09 5:43
mvaSergey Alexandrovich Kryukov10-Nov-09 5:43 
GeneralMy vote of 1 Pin
brian_agnes9-Nov-09 6:04
brian_agnes9-Nov-09 6:04 
GeneralShould be based on facts and reasoning Pin
Sergey Alexandrovich Kryukov9-Nov-09 6:36
mvaSergey Alexandrovich Kryukov9-Nov-09 6:36 
GeneralMy vote of 2 Pin
Ben Robbins8-Nov-09 21:48
Ben Robbins8-Nov-09 21:48 
GeneralRe: My vote of 2 [modified] Pin
ATANU.PODDER8-Nov-09 23:15
ATANU.PODDER8-Nov-09 23:15 
GeneralMy vote of 2 Pin
dequadin7-Nov-09 6:52
dequadin7-Nov-09 6:52 
GeneralRe: My vote of 2 Pin
ATANU.PODDER8-Nov-09 23:27
ATANU.PODDER8-Nov-09 23:27 
GeneralI understand the boxing reference Pin
Member 36807856-Nov-09 5:09
Member 36807856-Nov-09 5:09 
GeneralRe: I understand the boxing reference Pin
dberindei8-Nov-09 22:24
dberindei8-Nov-09 22:24 
GeneralRe: I understand the boxing reference Pin
Member 36807859-Nov-09 6:36
Member 36807859-Nov-09 6:36 
GeneralRe: I understand the boxing reference Pin
dberindei9-Nov-09 21:23
dberindei9-Nov-09 21:23 
GeneralRe: I understand the boxing reference [modified] Pin
Member 368078511-Nov-09 7:45
Member 368078511-Nov-09 7:45 
GeneralRe: I understand the boxing reference Pin
dberindei11-Nov-09 23:04
dberindei11-Nov-09 23:04 
Member 3680785 wrote:
I never claimed that "Object" and "var" were equivalent at a text replacement level.


My claim is that they are fundamentally different. var is only syntactic sugar, while Object changes the meaning of the code.

Member 3680785 wrote:
I can make my own methods take Objects, and then no casting is required.


If all you want to do with your object is add it to a collection or pass it to another function, you don't need a variable at all, so there's no point in talking about var/Object in that case.

However, if you're the one writing the methods, you need the cast inside the method. Plus you lose the type safety of C#, because your method can be called with objects of any type instead of only being called with your super-long-named type. There are situations where you want generic methods that can handle parameters of any type, but var was not designed for those situations. It's just a way to reduce typing and to make the code easier to read.

Think of it as auto in the upcoming C++0x. You wouldn't ever think of these lines as remotely equivalent in C++, would you?
<br />
  auto i = 1;<br />
<br />
  void* i = &1;<br />


Member 3680785 wrote:
That means that, unlike prior versions, .NET 3.0 couldn't aim at the (low) performance of Java.


.NET 3.0 did not change anything in the .NET CLR, all the changes were in the class libraries. See Wikipedia[^].

Member 3680785 wrote:
"Generics" in the overall sense (e.g. C++ and Java) definitely do move things forward in time. If you make a C++ template, for example, and then use it for (say) type "int," then code gets generated at compile-time with "int" put in place of your type parameter name.


In C++ the int type does not have any polymorphic operations, so there is nothing to move to compile time. You can certainly think of generics as an alternative to polymorphism, but once you've made a method virtual it remains virtual whether you put it in a template or not.

And I don't know why you brought in Java, because their generics are much weaker than .NET's: they are basically just syntactic sugar and they have almost 0 influence on the generated code.

Member 3680785 wrote:
However, I should also point out that I find this design to be asinine. IL has basically turned into Yet Another High-Level Language. It is no longer an assembly-like language like UCSD p-Code or Java bytecodes, both of which were in fact actually implemented directly in hardware at one point. IL has become just another bloated layer standing between the .NET programmer and the hardware.


p-code and Java bytecode were both designed to be interpreted, while IL was designed to be compiled. The first JDK to have a JIT was 1.1[^]. And IL was generic from the beginning, see this interview with Anders Hejlsberg on Artima[^]

Member 3680785 wrote:
I have blatantly assumed that "T" supports addition, with no basis in fact. But in C++, this compiles without error, unless and until someone uses the template for a type that really doesn't support addition.


You didn't get any error, but that didn't mean your code was actually compiled. In C++ the template definition is compiled (again and again) every time it is instantiated with a new type (in one compilation unit; different compilation units will again compile the same template for the same template parameters).

The fact that you can write a library and have it compile with 0 errors until someone actually tries to use it doesn't seem a strong point of C++ to me.
GeneralRe: I understand the boxing reference Pin
Indrora23-Nov-09 16:10
Indrora23-Nov-09 16:10 
GeneralRe: I understand the boxing reference Pin
dberindei23-Nov-09 21:42
dberindei23-Nov-09 21:42 
GeneralRe: I understand the boxing reference Pin
Indrora4-Dec-09 16:12
Indrora4-Dec-09 16:12 
GeneralRe: I understand the boxing reference Pin
dberindei9-Dec-09 2:17
dberindei9-Dec-09 2:17 
GeneralWhy comparing "object" with "var"? Pin
Sergey Alexandrovich Kryukov9-Nov-09 6:33
mvaSergey Alexandrovich Kryukov9-Nov-09 6:33 
GeneralRe: Why comparing "object" with "var"? Pin
Member 368078511-Nov-09 9:39
Member 368078511-Nov-09 9:39 
GeneralRe: Why comparing "object" with "var"? Pin
Sergey Alexandrovich Kryukov11-Nov-09 12:14
mvaSergey Alexandrovich Kryukov11-Nov-09 12:14 
GeneralMy vote of 2 Pin
Utwig6-Nov-09 2:58
Utwig6-Nov-09 2:58 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.