Estandares de Codificacion y nomenclatura C#

 Muchos nos iniciamos en el mundo de la programación escribiendo código y testeando, si funciona seguimos avanzando hacia el siguiente tópico de estudio o meta que nos hayamos trazado, olvidándonos de los estándares y nomenclaturas utilizados en el lenguaje de programación que estemos utilizando; en nuestro caso estaremos estudiando algunos estándares y nomenclaturas utilizados en C#.

Aquí vamos!!

A continuación presentare algunos  estándares de codificación C#, las convenciones de nombres, y las mejores prácticas.
Puedes Utilizarlos en tus propios proyectos y / o ajustarlos a tus propias necesidades.

Usa PascalCasing.

Esta la usamos para los nombres de métodos y clases.

Que es PascalCasing?

Es un procedimiento de programación común en el lenguaje Java y .Net. La nomenclatura está compuesta por tantas palabras como sean necesarias. La primera letra de cada una de las palabras irá siempre en mayúsculas. Debemos tener en cuenta que se omite el uso de articulos.

Ejemplo: GetInformation y no GetTheInformation.

public class ClientInformation
{
    public void ClearData()
    {
        //...
    }
    public void CalculateData()
    {
        //...
    }
}

Razon: Consistente con el Microsoft .NET Framework y fácil de leer.

Usa camelCasing.

Esta la usamos para los argumentos de métodos y variables locales.

Que es camelCasing? Es un estilo de escritura que se aplica a frases o palabras compuestas. El nombre se debe a que las mayúsculas a lo largo de una palabra en CamelCase se asemejan a las jorobas de un camello.

Ejemplo:

public class EventLog
{
    public void Add(LogEvent logEvent)
    {
        int itemCount = logEvent.Items.Count;
        // ...
    }
}

Razon: Consistente con el Microsoft .NET Framework y fácil de leer.

No uses Hungarian.

No usar notación o cualquier otro tipo de identificación en los identificadores

Ejemplo:

// Correcto
int contador;
string nombre;
 
// Evita
int iContador;
string strNombre;

Razón: Consistente con el Microsoft .NET Framework y Visual Studio IDE hace que la determinación de tipos sea más fácil. En general se quiere evitar indicadores de tipo en cualquier identificador.

No uses Screaming Caps.

Es decir evita gritar mayúsculas para  constantes y variables de sólo lectura.

Ejemplo.

// Correcto
public static const string TipoEntrega = "VIP";
 
// Evita
public static const string TIPOENTREGA = "VIP";

Razón: Consistente con el Microsoft .NET Framework. Las mayúsculas llaman demasiada atención.

 

Evita usar abreviaciones.

Evita usar abreviaciones excesivas, con excepción de abreviaciones comúnmente usadas como: Id, Xml, Ftp, Uri.

Ejemplo:

// Correcto
UserGroup userGroup;
Assignment employeeAssignment;
 
// Evita
UserGroup usrGrp;
Assignment empAssignment;
 
// Excepciones
CustomerId customerId;
XmlDocument xmlDocument;
FtpHelper ftpHelper;
UriPart uriPart;

Razón: Consistente con el Microsoft .NET Framework y evita abreviaturas inconsistentes.

 

No uses Underscores.

No uses underscores en identificadores. Excepción: se puede prefijar las variables estáticas privadas con un underscores.

Ejemplo:

// Correcto
public DateTime citacliente;
public TimeSpan tiempotranscurrido;
 
// Evita
public DateTime cita_cliente;
public TimeSpan tiempo_transcurrido;
 
// Excepcion
private DateTime _fechaRegistro;

Razón: Consistente con el Microsoft .NET Framework y hace que el código sea más natural para leer.

 

Resumen: En esta entrada aprendimos algunas buenas practicas a la hora de escribir código así como las nomenclaturas y buenas practicas, si conoces alguna déjanos saber en los comentarios.

En una próxima entrada seguiremos tratando tan amplio tema.

Si te ha gustado esta Entrada, por favor, compartir y dejar su comentario a continuación. Si tienes alguna pregunta, no dude en enviar aquí. Voy a responder a todas las preguntas! 🙂 .

 

 

 

 

 

 

 

Comments

5s comentarios

  1. Muchas gracias por elaborarlo y compartir tus conocimientos, esto cae muy bien a personas como yo que esamos en esa fase de aprendizaje 🙂 siempre es bueno conocer como trabajan personas expertas y lo que recomiendan en su dia a dia.

Dejar una contestacion

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *