Best Practices : What to use, .Net Class or short name?

Question

In C# we have .Net class and the short names, like Double and double. I was suggested sometime back that we shall use the short name always, wanted to know why. I know they both are same, but why one is sometimes preferred over others? Just readability or is there something more to it?

For example if I am creating a Class having a string and a boolean properties, which of the following should be used always and when the other should be used:

Class MyClass {
    ...
    private String x;
    private Boolean y;
    ...
}

OR

Class MyClass {
    ...
    private string x;
    private bool y;
    ...
}

See http://stackoverflow.com/questions/6000517/c-sharp-stylecop-sa1121-usebuiltintypealias-readability-rules for StyleCop rule discussion — Max Yakimets, Dec 16 '12 at 15:08
@MaxYakimets Oh Thanks :) that was very very useful :), So ultimately it's a personal choice, right ? — Amar, Dec 16 '12 at 15:20

score 5 · Accepted Answer · edited Jul 11 '13 at 16:53

5

In short: Do it like you want.

I would prefer to use the alias every time I can.

Use Int32 instead of int when you have several different Ints in your Code. Like mixing Int32, Int64 or Int16.

edited Jul 11 '13 at 16:53

Display Name

8,022
3
31
66

answered Dec 16 '12 at 15:02

Johannes Wanzek

2,825
2
29
47

Richter says that using real names is more clear for people that use many languages(not only C#). And I think he is right. – Display Name Jul 11 '13 at 16:49
Yes of course, but imagine you have a code block where you use mixed `short`, `int`, `long` etc. it would be more easy to understand using `Int16`, `Int32` and `Int64` – Johannes Wanzek Jun 06 '14 at 08:08
1

So? I said the same thing — using real names (not aliases). – Display Name Jun 06 '14 at 09:50
Ah sorry then I got you wrong. My fault. – Johannes Wanzek Jun 06 '14 at 10:15

score 3 · Answer 2 · answered Dec 16 '12 at 15:02

3

Well, they are the same. After compilation to CLR they both point to same datatype.

answered Dec 16 '12 at 15:02

csg

2,047
2
22
35

score 3 · Answer 3 · edited May 23 '17 at 12:04

You can use either Int32 or int in your code, but you should use it in a convenient way, you shouldn't use them both, it can make the code unreadable, but C# conventions say that you should use synonyms always.

Some times, you may mix between "Wrapper Classes" those are in Java, and "Nullable Types" in .Net, or "Type Synonyms of C#"

In C# "int" and "Int32" are the same, "bool and "Boolean" are the same, "string" and "String" are the same, but "int" is the synonymous in C# language of "System.Int32" class of .Net.

You can use "int?" or Nullable<int> to make the variable accept "null" value but in Java you should use the wrapper class Integer instead of integer to hold 'null' values.

score 3 · Answer 4 · answered Dec 16 '12 at 15:05

3

That is entirely dependent on you. For some readability is more imporatant. So use the one which is more readable and convinient to you.

Aliases are just used because of there convinience but they are the same as the actual ones for compilers.

answered Dec 16 '12 at 15:05

Rahul Tripathi

168,305
31
280
331

score 3 · Answer 5 · answered Dec 16 '12 at 15:09

string is an alias for System.String, bool is an alias for System.Boolean and so on. The C# type keywords and their aliases are interchangeable.

I personally prefer the usage of aliases unless I need to emphasize the explicit type in case this information may be needed in the future. Such as using System.Int32 instead if int to explicitly show that there's a limitation, even if they are exactly the same.

Ilia G · Answer 6 · 2012-12-16T15:20:39.493

3

You should you use class name when you need to access static methods and short name when declaring a variable/field of given type.

int i = 0;
Int32.TryParse(s, out i);

See any of the Microsoft code samples http://msdn.microsoft.com/en-us/library/system.int32.aspx

There is no difference in compiled code from doing it any other way. It is just cleaner and more readable.

edited Dec 16 '12 at 15:20

answered Dec 16 '12 at 15:10

Ilia G

10,043
2
40
59

Where did you see this convention of C#? – Saw Dec 16 '12 at 15:11
@MSakherSawan that is the format MS usually use in their sample code. – Ilia G Dec 16 '12 at 15:15
1

You may be right, but I can show you many microsoft samples using int.TryParse instead of Int32.TryParse, but it seams that there is no convention for this. – Saw Dec 16 '12 at 15:24
http://msdn.microsoft.com/en-us/library/bb384043.aspx – Saw Dec 16 '12 at 15:25

score 1 · Answer 7 · edited Oct 04 '21 at 10:57

1

int, bool, string, etc. are only aliases of predefined types in the System namespace.

Full list here: Built-in types (C# reference).

edited Oct 04 '21 at 10:57

Wai Ha Lee

8,598
83
57
92

answered Dec 16 '12 at 15:03

Mahmoud Farahat

5,364
4
43
59

Best Practices : What to use, .Net Class or short name?

7 Answers7

Linked