[C#] Estandares de Codificacion y Convenciones de Nomenclatura

Correcto

Usar PascalCasing para nombrar clases y métodos. Así es consistente con .NET y fácil para leer.

    public class DeveloperAction
{
public void CodeSomething()
{
//...
}
public void CommentSomething()
{
//...
}
}

Correcto

Usar camelCasing para argumentos de métodos y variables globales.

    public class DeveloperAction
{
public void CodeSomething(Code code)
{
int instructionsCount = code.Instructions.Count;
//...
}
}

Incorrecto

Usar notación Hungariana o algún identificador de tipos en las variables o métodos.

            // Correcto
int contador;
string nombres;

// Incorrecto
int iContador;
string strNombres;

Incorrecto

Usar mayúsculas para constantes o variables de solo lectura. Las mayúsculas llaman mucho la atención.

            // Correcto
public static const string LoginProvider = "Live";

// Incorrecto
public static const string LOGINPROVIDER = "Live";

Incorrecto

Usar abreviaciones. Excepciones: abreviaciones usados comúnmente como nombres, por ejemplo: Id, Xml, Ftp, Uri. Asi es consistente con .NET y evita abreviaciones inconsistentes.

        // Correcto
DeveloperAction developerAction;
BlogWriter blogWriter;

// Incorrecto
DeveloperAction dvpAct;
BlogWritter writer;

// Excepciones
UserId userId;
XmlDocument xmlDocument;
FtpHelper ftpHelper;
UriPart uriPart;

Incorrecto

Usar subguion en identificadores. Excepción: Puedes prefijar variables estáticas privadas con un subguión. Asi es consistente con .NET


// Correcto
public DateTime fechaModificacion;
public TimeSpan tiempoTranscurrido;

// Incorrecto
public DateTime fecha_Modificacion;
public TimeSpan tiempo_Transcurrido;

// Excepción
private DateTime _fechaCreacion;

Correcto

Utilizar los alias de tipos primitivos en lugar de nombres de tipos de sistema como String, Int32, UInt64, Boolean, etc. Así es consistente con .NET y más natural para leer.


// Correcto
string nombres;
int edad;
bool esFacil;

// Incorrecto
String nombres;
Int32 edad;
Boolean esFacil;

Correcto

Utiliza sustantivo o frases nominales para nombrar una clase. Así es consistente con .NET y fácil de recordar.


public class Developer
{
}
public class ItemLocation
{
}
public class WorkItem
{
}

Correcto

Declara todas las variables miembro en la parte superior de una clase, con las variables estáticas en la parte superior. Esta es una práctica generalmente aceptada ya que evita la necesidad de cazar las declaraciones de variables.


// Correcto
public class User
{
public static string ModuleName;

public string Name { get; set; }
public string Code { get; set; }
public DateTime RegisterDate { get; set; }
public int Points { get; set; }

public User()
{
}
}

Correcto

Usar nombres en singular para los enumerados.


public enum Color
{
Red,
Green,
Blue,
Yellow,
Magenta,
Cyan
}

Incorrecto

Establecer como sufijo Enum a los enumerados.


public enum ColorEnum
{
Red,
Green,
Blue,
Yellow,
Magenta,
Cyan
}

Agregue un comentario

Su dirección de correo no se hará público. Los campos requeridos están marcados *