📜  C#编码标准

📅  最后修改于: 2021-05-30 00:06:30             🧑  作者: Mango

C#是通用的,现代且面向对象的编程语言,发音为“ C Sharp”。它是由Anders Hejlsberg和他的团队在.NET倡议下由Microsoft开发的,并得到了欧洲计算机制造商协会(ECMA)和国际标准组织(ISO)的批准。 C#是公共语言基础结构的语言之一。 C#在语法上与Java非常相似,并且对具有C,C++或Java知识的用户来说很容易。

下面是所有.Net开发人员应遵循的一些最佳做法:

1.类名和方法名应始终以Pascal大小写

public class Employee
{
    public Employee GetDetails()
    {
        //...
    }
    public double GetBonus()
    {
        //...
    }
}

2.方法参数和局部变量应始终为驼峰式

public class Employee
{
    public void PrintDetails(int employeeId, String firstName)
    {
        int totalSalary = 2000;
        // ...
    }
}

3.命名标识符时避免使用下划线

// Correct
public DateTime fromDate;
public String firstName;
 

// Avoid
public DateTime from_Date;
public String first_Name;

4.避免使用系统数据类型,而首选使用预定义数据类型。

// Correct
int employeeId;
string employeeName;
bool isActive;
 

// Avoid
Int32 employeeId;
String employeeName;
Boolean isActive;

5.始终在接口前面加上字母I。

// Correct
public interface IEmployee
{
}
public interface IShape
{
}
public interface IAnimal
{
}

// Avoid
public interface Employee
{
}
public interface Shape
{
}
public interface Animal
{
}

6.为了获得更好的代码缩进和可读性,请始终将花括号垂直对齐。

// Correct
class Employee
{
    static void PrintDetails()
    {
    }
}
 

// Avoid
class Employee
    {
    static void PrintDetails()
    {
      }
}

7.处理一次性类型时,请始终使用using关键字。当程序流离开作用域时,它将自动处置对象。

using(var conn = new SqlConnection(connectionString))
{
    // use the connection and the stream
    using (var dr = cmd.ExecuteReader())
    {
     //
    }
}

8.始终声明变量尽可能接近它们的用法。

// Correct
String firstName = "Shubham";
Console.WriteLine(firstName);
//--------------------------
 

// Avoid
String firstName = "Shubham";
//--------------------------
//--------------------------
//--------------------------
Console.WriteLine(firstName);

9.始终将属性声明为私有,以实现封装并确保数据隐藏。

// Correct
private int employeeId { get; set; }

// Avoid
public int employeeId { get; set; }

10.始终将方法和程序的不同部分分开一个空格。

// Correct
class Employee
{
private int employeeId { get; set; }

public void PrintDetails()
{
//------------
}
}

// Avoid
class Employee
{

private int employeeId { get; set; }



public void PrintDetails()
{
//------------
}

}

11.常量应始终在UPPER_CASE中声明。

// Correct
public const int MIN_AGE = 18;
public const int MAX_AGE = 60;

// Avoid
public const int Min_Age = 18;
public const int Max_Age = 60;