Estándares de codificación C#

C# es un lenguaje de programación de propósito general, moderno y orientado a objetos pronunciado como “C Sharp”. Fue desarrollado por Microsoft liderado por Anders Hejlsberg y su equipo dentro de la iniciativa .NET y fue aprobado por la Asociación Europea de Fabricantes de Computadoras (ECMA) y la Organización Internacional de Estándares (ISO). C# se encuentra entre los lenguajes de Common Language Infrastructure. C# es muy similar a Java sintácticamente y es fácil para los usuarios que tienen conocimientos de C, C++ o Java . 

A continuación se presentan algunas de las mejores prácticas que todos los desarrolladores de .Net deben seguir: 

1. Los nombres de clases y métodos siempre deben estar en Pascal Case 

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

2. El argumento del método y las variables locales siempre deben estar en Camel Case  

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

3. Evite el uso de guiones bajos al nombrar identificadores  

// Correct
public DateTime fromDate;
public String firstName;
 

// Avoid
public DateTime from_Date;
public String first_Name;

4. Evite el uso de tipos de datos del sistema y prefiera utilizar los tipos de datos predefinidos.  

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

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

5. Siempre prefije una interfaz con la letra I.  

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

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

6. Para una mejor sangría y legibilidad del código, alinee siempre las llaves en forma vertical.  

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

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

7. Utilice siempre la palabra clave using cuando trabaje con tipos desechables. Elimina automáticamente el objeto cuando el flujo del programa sale del alcance.  

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

8. Declarar siempre las variables lo más cerca posible de su uso.  

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

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

9. Declare siempre las propiedades como privadas para lograr la Encapsulación y garantizar la ocultación de datos.  

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

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

10. Siempre separe los métodos, diferentes secciones del programa por un espacio.  

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

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

// Avoid
class Employee
{

private int employeeId { get; set; }



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

}

11. Las constantes siempre deben declararse en MAYÚSCULAS.  

// 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;