|
C# Coding Standards and Best Programming Practices
Anybody can write code! And with a few months of programming experience, you can write 'working applications'. Making it work is easy, but doing it the most efficient way requires more work, than just making it work!
Believe it, majority of the programmers write 'Working Code', but not 'Efficient Code'. As we mentioned in the beginning of this tutorial, do you want to become the 'Most Valued Professional' of your company? Writing 'Efficient Code' is an art and you must learn and practice it.
Naming Conventions and Standards
Note :
Pascal Casing - First character of all words are Upper Case and other characters are lower case.
Camel Casing - First character of all words, except the first word are Upper Case and other characters are lower case.
Use Pascal casing for Class names
public class HelloWorld
{
...
}
Use Pascal casing for Method names
public class HelloWorld
{
void SayHello(string name)
{
...
}
}
Use Camel casing for variables and method parameters
public class HelloWorld
{
int totalCount = 0;
void SayHello(string name)
{
string fullMessage = "Hello " + name;
...
}
}
Do not use Hungarian notation to name variables.
In earlier days most of the programmers liked it - having the data type as a prefix for the variable name and using m_ as prefix for member variables. Eg:
string m_sName;
int nAge;
However, in .NET coding standards, this is not reccommended. Usage of datatype and M_ to represent member variables should not be used. All variables should use camel casing.
Use Meaningfull, descriptive words to name variables.
- Do not use abbreviations. Use name, address, salary etc instead of nam, addr, sal
- Do not use single character variable names like i, n, x etc. Use names like index, temp
One exception in this case would be variables used for iterations in loops: for ( int i = 0; i < count; i++ )
{
...
}
If the variable is used only as a counter for iteration and is not used anywhere else in the loop, many people still like to use a single char variable (i) instead of inventing a different suitable name.
- Do not use underscores (_) in variable names.
- Namespace names should follow the standard pattern
<company name>.<product name>.<top level module>.<bottom level module>
File name should match with class name
For example, for the class HelloWorld, the file name should be helloworld.cs (or, helloworld.vb)
Indentation and Spacing
Use TAB for indentation. Do not use SPACES.
Comments should be in the same level as the code.
Curly braces ( {} ) should be in the same level as the code outside teh braces.
Use one blank line to separate logical groups of code.
bool SayHello (string name)
{
string fullMessage = "Hello " + name;
DateTime currentTime = DateTime.Now;
string message = fullMessage + ", the time is : " + currentTime.ToShortTimeString();
MessageBox.Show ( message );
if ( ... )
{
// Do something
// ...
return false;
}
return true;
}
This code looks better, than the code shown above: bool SayHello ( string name )
{
string fullMessage = "Hello " + name;
DateTime currentTime = DateTime.Now;
string message = fullMessage + ", the time is : " + currentTime.ToShortTimeString();
MessageBox.Show ( message );
if ( ... )
{
// Do something
// ...
return false;
}
return true;
}
There should be one and only one single blank line between each method inside the class.
The curly braces should be on a separate line adn not in the same line as if, for etc.
Good: if ( ... )
{
// Do something
}
Not Good: if ( ... ) {
// Do something
}
Use a single space before and after each operator and brackets.
Good: if ( showResult == true )
{
for ( int i = 0; i < 10; i++ )
{
//
}
}
Not Good: if(showResult==true)
{
for(int i= 0;i<10;i++)
{
//
}
}
Good Programming practices
Follow the best practices to for best programming
Avoid having too large files. If a file has more than 300~400 lines of code, you must consider refactoring code into helper classes.
Avoid writing very long methods. A method should typically have 1~25 lines of code. If a method has more than 25 lines of code, you must consider re factoring into separate methods.
Method name should tell what it does. Do not use mis-leading names. If the method name is obvious, there is no need of documentation explaining what the method does.
Good: void SavePhoneNumber ( string phoneNumber )
{
// Save the phone number.
}
Not Good: // This method will save the phone number.
void SaveData ( string phoneNumber )
{
// Save the phone number.
}
A method should do only 'one job'. Do not combine more than one job in a single method, even if those jobs are very small.
Good: // Save the address.
SaveAddress ( address );
// Send an email to the supervisor to inform that the address is updated.
SendEmail ( address, email );
void SaveAddress ( string address )
{
// Save the address.
// ...
}
void SendEmail ( string address, string email )
{
// Send an email to inform the supervisor that the address is changed.
// ...
}
Not Good: // Save address and send an email to the supervisor to inform that the address is updated.
SaveAddress ( address, email );
void SaveAddress ( string address, string email )
{
// Job 1.
// Save the address.
// ...
// Job 2.
// Send an email to inform the supervisor that the address is changed.
// ...
}
Use the c# or VB.NET specific types, rather than the alias types defined in System namespace.
Good: int age;
string name;
object contactInfo;
Not Good: Int16 age;
String name;
Object contactInfo;
Do not hardcode numbers. Use constants instead.
Do not hardcode strings. Use resource files.
Avoid using many member variables. Declare local variables and pass it to methods instead of sharing a member variable between methods. If you share a member variable between methods, it will be difficult to track which method changed the value and when.
Use enum wherever required. Do not use numbers or strings to indicate discrete values.
Good: enum MailType
{
Html,
PlainText,
Attachment
}
void SendMail (string message, MailType mailType)
{
switch ( mailType )
{
case MailType.Html:
// Do something
break;
case MailType.PlainText:
// Do something
break;
case MailType.Attachment:
// Do something
break;
default:
// Do something
break;
}
}
Not Good: void SendMail (string message, string mailType)
{
switch ( mailType )
{
case "Html":
// Do something
break;
case "PlainText":
// Do something
break;
case "Attachment":
// Do something
break;
default:
// Do something
break;
}
}
Do not make the member variables public or protected. Keep them private and expose public/protected Properties.
Never hardcode a path or drive name in code. Get the application path programmatically and use relative path.
Never assume that your code will run from drive "C:". You may never know, some users may run it from network or from a "Z:".
In the application start up, do some kind of "self check" and ensure all required files and dependancies are available in the expected locations. Check for database connection in start up, if required. Give a friendly message to the user in case of any problems.
If the required configuration file is not found, application should be able to create one with default values.
If a wrong value found in the configuration file, application should throw an error or give a message and also should tell the user what are the correct values.
Error messages should help the user to solve the problem. Never give error messages like "Error in Application", "There is an error" etc. Instead give specific messages like "Failed to update database. Please make sure the login id and password are correct."
When displaying error messages, in addition to telling what is wrong, the message should also tell what should the user do to solve the problem. Instead of message like "Failed to update database.", suggest what should the user do: "Failed to update database. Please make sure the login id and password are correct."
Show short and friendly message to the user. But log the actual error with all possible information. This will help a lot in diagnosing problems.
Comments
Do not write comments for every line of code and every variable declared.
Write comments wherever required. But good readable code will require very less comments. If all variables and method names are meaningfull, that would make the code very readable and will not need much comments.
Less lines of comments will make the code more elegant. But if the code is not clean/readable and there are less comments, that is worse.
If you have to use some complex or weired logic for any reason, document it very well with sufficient comments.
If you initialize a numeric variable to a special number other than 0, -1 etc, document the reason for choosing that value.
The bottom line is, write clean, readable code such a way that it doesn't need any comments to understand.
Do a spell check on comments and also make sure proper grammar and punctuation is used.
Exception Handling
Never do a 'catch exception and do nothing'. If you hide an exception, you will never know if the exception happened or not.
In case of exceptions, give a friendly message to the user, but log the actual error with all possible details about the error, including the time it occurred, method and class name etc.
Always catch only the specific exception, not generic exception.
Good: void ReadFromFile ( string fileName )
{
try
{
// read from file.
}
catch (FileIOException ex)
{
// log error.
// re-throw exception depending on your case.
throw;
}
}
Not Good: void ReadFromFile ( string fileName )
{
try
{
// read from file.
}
catch (Exception ex)
{
// Catching general exception is bad... we will never know whether it
// was a file error or some other error.
// Here you are hiding an exception.
// In this case no one will ever know that an exception happened.
return "";
}
}
No need to catch the general exception in all your methods. Leave it open and let the application crash. This will help you find most of the errors during development cycle.
You can have an application level (thread level) error handler where you can handle all general exceptions. In case of an 'unexpected general error', this error handler should catch the exception and should log the error in addition to giving a friendly message to the user before closing the application, or allowing the user to 'ignore and proceed'.
Do not write try-catch in all your methods. Use it only if there is a possibility that a a specific exception may occur. For example, if you are writing into a file, handle only FileIOException.
Do not write very large try-catch blocks. If required, write separate try-catch for each task you perform and enclose only the specific piece of code inside the try-catch. This will help you find which piece of code generated the exception and you can give specific error message to the user.
You may write your own custom exception classes, if required in your application. Do not derive your custom exceptions.
|
Want to format C# source code automatically? Use