Reply to thread

Message

Part II

Programming Practices
Visibility

Do not make any instance or class variable public, make them private. For private members prefer not using “private” as modifier just do write nothing. Private is the default case and every C# programmer should be aware of it.

Use properties instead. You may use public static fields (or const) as an exception to this rule, but it should not be the rule.
9.2 No 'magic' Numbers

Don’t use magic numbers
, i.e. place constant numerical values directly into the source code. Replacing these later on in case of changes (say, your application can now handle 3540 users instead of the 427 hardcoded into your code in 50 lines scattered troughout your 25000 LOC) is error-prone and unproductive. Instead declare a const variable which contains the number :

[code]
public class MyMath
{
public const double PI = 3.14159...
}
[/code]

Brace code example
[code]
namespace ShowMeTheBracket
{
public enum Test
{
TestMe,
TestYou
}

public class TestMeClass
{
Test test;
public Test Test
{
get
{
return test;
}
set
{
test = value;
}
}

void DoSomething()
{
if (test == Test.TestMe)
{
//...stuff gets done
}
else
{
//...other stuff gets done
}
}
}
}
[/code]

Variable naming example

[code]
for (int primeCandidate = 1; primeCandidate < num; ++primeCandidate)
{
isPrime[primeCandidate] = true;
}
for (int factor = 2; factor < num / 2; ++factor)
{
int factorableNumber = factor + factor;
while (factorableNumber <= num)
{
isPrime[factorableNumber] = false;
factorableNumber += factor;
}
}
for (int primeCandidate = 0; primeCandidate < num; ++primeCandidate)
{
if (isPrime[primeCandidate])
{
Console.WriteLine(primeCandidate + " is prime.");
}
}
[/code]

<blockquote data-quote="Frodo" data-source="post: 6038" data-attributes="member: 10277">Part IIProgramming PracticesVisibilityDo not make any instance or class variable public, make them private. For private members prefer not using “private” as modifier just do write nothing. Private is the default case and every C# programmer should be aware of it.Use properties instead. You may use public static fields (or const) as an exception to this rule, but it should not be the rule.9.2 No 'magic' NumbersDon’t use magic numbers, i.e. place constant numerical values directly into the source code. Replacing these later on in case of changes (say, your application can now handle 3540 users instead of the 427 hardcoded into your code in 50 lines scattered troughout your 25000 LOC) is error-prone and unproductive. Instead declare a const variable which contains the number :[code]public class MyMath{&nbsp; public const double PI = 3.14159...}[/code]Brace code example[code]namespace ShowMeTheBracket{&nbsp; &nbsp; public enum Test &nbsp; &nbsp; {&nbsp; &nbsp; &nbsp; &nbsp; TestMe,&nbsp; &nbsp; &nbsp; &nbsp; TestYou&nbsp; &nbsp; }&nbsp; &nbsp; public class TestMeClass&nbsp; &nbsp; {&nbsp; &nbsp; &nbsp; &nbsp; Test test;&nbsp; &nbsp; &nbsp; &nbsp; public Test Test &nbsp; &nbsp; &nbsp; &nbsp; {&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; get &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; return test;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; set &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; test = value;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }&nbsp; &nbsp; &nbsp; &nbsp; }&nbsp; &nbsp; &nbsp; &nbsp; void DoSomething()&nbsp; &nbsp; &nbsp; &nbsp; {&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; if (test == Test.TestMe) &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; //...stuff gets done&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; } &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; else &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; {&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; //...other stuff gets done&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; }&nbsp; &nbsp; &nbsp; &nbsp; }&nbsp; &nbsp; }}[/code]Variable naming example[code]for (int primeCandidate = 1; primeCandidate &lt; num; ++primeCandidate){&nbsp; &nbsp; isPrime[primeCandidate] = true;}for (int factor = 2; factor &lt; num / 2; ++factor) {&nbsp; &nbsp; int factorableNumber = factor + factor;&nbsp; &nbsp; while (factorableNumber &lt;= num) &nbsp; &nbsp; {&nbsp; &nbsp; &nbsp; &nbsp; isPrime[factorableNumber] = false;&nbsp; &nbsp; &nbsp; &nbsp; factorableNumber += factor;&nbsp; &nbsp; }}for (int primeCandidate = 0; primeCandidate &lt; num; ++primeCandidate){&nbsp; &nbsp; if (isPrime[primeCandidate]) &nbsp; &nbsp; {&nbsp; &nbsp; &nbsp; &nbsp; Console.WriteLine(primeCandidate + &quot; is prime.&quot;);&nbsp; &nbsp; }}[/code]</blockquote>

[QUOTE="Frodo, post: 6038, member: 10277"] [b]Part II[/b] [b]Programming Practices[/b] Visibility Do not make any instance or class variable public, make them private. For private members prefer not using “private” as modifier just do write nothing. Private is the default case and every C# programmer should be aware of it. Use properties instead. You may use public static fields (or const) as an exception to this rule, but it should not be the rule. 9.2 No 'magic' Numbers [b]Don’t use magic numbers[/b] , i.e. place constant numerical values directly into the source code. Replacing these later on in case of changes (say, your application can now handle 3540 users instead of the 427 hardcoded into your code in 50 lines scattered troughout your 25000 LOC) is error-prone and unproductive. Instead declare a const variable which contains the number : [code] public class MyMath { public const double PI = 3.14159... } [/code] [b]Brace code example[/b] [code] namespace ShowMeTheBracket { public enum Test { TestMe, TestYou } public class TestMeClass { Test test; public Test Test { get { return test; } set { test = value; } } void DoSomething() { if (test == Test.TestMe) { //...stuff gets done } else { //...other stuff gets done } } } } [/code] [b]Variable naming example[/b] [code] for (int primeCandidate = 1; primeCandidate < num; ++primeCandidate) { isPrime[primeCandidate] = true; } for (int factor = 2; factor < num / 2; ++factor) { int factorableNumber = factor + factor; while (factorableNumber <= num) { isPrime[factorableNumber] = false; factorableNumber += factor; } } for (int primeCandidate = 0; primeCandidate < num; ++primeCandidate) { if (isPrime[primeCandidate]) { Console.WriteLine(primeCandidate + " is prime."); } } [/code] [/QUOTE]