C# Best Practices
22/06/2019 . 3 minutes, 32 seconds to read . Posted by Admin#c# #best-practices
Naming Conventions
- Pascal Case
- Camel Case
Pascal Case
The first characters of all words are Upper Case and other characters are lower case.
Example
Camel Case
The first letter is in lowercase and the first letter of every subsequent concatenated word is in caps.
OR
The first character of all words, except the first word, is Upper Case and other characters are lower case.
Example
Naming Conventions and Standards
Use Pascal casing for Class names.
Example
The first characters of all words are Upper Case and other characters are lower case.
Example
CaseHistoryCamel Case
The first letter is in lowercase and the first letter of every subsequent concatenated word is in caps.
OR
The first character of all words, except the first word, is Upper Case and other characters are lower case.
Example
businessCaseNaming Conventions and Standards
Use Pascal casing for Class names.
Example
public class BusinessCase
{
//.........
} Use Pascal casing for Method names.
Example
Example
void AutoComplete(string name)
{
// ......
} Use Camel casing for variables and method parameters.
Example
Example
int totalCount = 0;
void AutoComplete(string name)
{
string fullMessage = "Hello " + name;
} Use Meaningful, descriptive words to name variables. Do not use abbreviations.
Example
Example
Good
- string address;
- int salary;
Bad
- string nam;
- string addr;
- int sal;
Example
Use 'is' keyword for boolean functions
private bool _isFinished ();The prefix for the UI elements should be appropriate so that you can identify them from the rest of the variables. A brief list is given below.
Example
| Control | Prefix |
| Label | lbl |
| TextBox | txt |
| DataGrid | dtg |
| Button | btn |
| ImageButton | imb |
Use Pascal Case for file names.
Indentation and Spacing
Use TAB for indentation. Do not use SPACES. Define the Tab size as 4.
Comments should be on the same level as the code (use the same level of indentation).
Example
Good
Comments should be on the same level as the code (use the same level of indentation).
Example
Good
// Format a message and display
string myMessage = " C# best practices ";
DateTime currentTime = DateTime.Now;
string infoMessage = myMessage + ", the time is : " + currentTime.ToShortTimeString();
MessageBox.Show( infoMessage ); Bad
// Format a message and display
string myMessage = " C# best practices ";
DateTime currentTime = DateTime.Now;
string infoMessage = myMessage + ", the time is : " + currentTime.ToShortTimeString();
MessageBox.Show ( infoMessage ); The code should be properly formatted.
separate logical groups of code Using one blank line.
Example
Good
bool ShowMessage(string name) {
string fullName = "Hello " + name;
DateTime currentTime = DateTime.Now;
string message = fullName + ", the time is : " + currentTime.ToShortTimeString();
MessageBox.Show(message);
if (...) {
// Write your code here
// ...
return false;
}
return true;
} Bad
Format the code using curly braces and separate the method with new line.
Example
Good
bool ShowMessage(string name) {
string fullName = "Hello " + name;
DateTime currentTime = DateTime.Now;
string message = fullName + ", the time is : " + currentTime.ToShortTimeString();
MessageBox.Show(message);
if (...) { // code here
// ... return false;
}
return true;
}Format the code using curly braces and separate the method with new line.
Example
Good
if ( ... )
{
// write your code here
} Bad
if ( ... ) {
// Write your code here } Always use a single space before and after operators and braces.
Example
Good
Example
Good
if(showResult)
{
for ( int j = 0; j < 10; j++ )
{
//
}
} Bad
if(showResult==true)
{
for(int j= 0;j<10;j++)
{
//
}
} Superb Programming Practices
Method name should clarify the meaning. Do not use misleading names. If the method name is clear then there is no need of documentation.
Example
Good
Method name should clarify the meaning. Do not use misleading names. If the method name is clear then there is no need of documentation.
Example
Good
void SaveStudentDetails (string studentDetails )
{
// Save the student details.
} Bad
// This method will save the student details.
void SaveDetails (string student )
{
// Save the student details.
} A method should do only one job at a time. Do not use it for more than one job.
Example
Good
Example
Good
//Save student details
SaveStudentDetails();
//Send email to user that student details is added successfully.
SendEmail(); Bad
//Save student details
Public void SaveStudentDetails()
{
// First task
//Save student details
//Second task
// Send emails
} Make sure string comparisons convert string to uppercase or lowercase for comparison.
Example
Good
Example
Good
If(UserName.ToLower()=="tom")
{
// write yor logic here
} Bad
If(UseName=="TOm")
{
//
} Comments
- Do not write comments for every line of code and every variable declared.
- Use // or /// for comments. Avoid using /* … */
- Write comments where is it required. But they should be well readable and limited. If all variables and method names are perfectly meaningful, then there is no need for any comments.
- If you initialize a numeric variable to a special number other than 0, -1, etc, document the reason for choosing that value.
- Make sure to perform spelling check on comments and make sure proper grammar and punctuation is used.
Enum
Always use a singular noun for defining enum.
Example
Enum Mailtype
{
Subject,
Body,
PlaneText
} Interface
Always use the letter "I" as a prefix with the name of an interface. After the letter I, use PascalCase.
Example
Always use the letter "I" as a prefix with the name of an interface. After the letter I, use PascalCase.
Example
public interface IMultiply
{
int Multiplication();
}