Mejores Practicas de Programación

En esta ocasión les compartiré un par de consejos para buenas practicas al momento de la codificación en ASP.Net C#, son sencillas y  muy básicas pero sin lugar a dudas serán de mucha ayuda para documentar y entender mejor el código y claro se vera mucho más limpia tu programación.

 

Uso de Regiones

 

Las regiones (#region) agrupan código, permitiendo colapsar o doblar la sección para mejorar la legibilidad y navegación de una clase. Solo podrán ponerse a nivel de clase, nunca dentro de un método.

Una clase deberá tener las siguientes regiones:

• Propiedades
• Constructores
• Variables globales
• Delegados
• Manejadores de Eventos
• Operaciones Publicas
• Operaciones Privadas

LinQ y Métodos encadenados

 

Los métodos encadenados, comunes en LinQ, tienden a ser muy largos en una sola línea de código. Si se tiene este caso, deben romperse en múltiples líneas, comenzando siempre por el punto y el nombre de la operación:

resultado = db.MiTabla

     .Where(item => item.InterfaceID == interfazId)

     .OrderBy(item => item.PosicionOrden)

     .ToList();

Al pasar delegados o definiciones de métodos anónimos a los métodos de consulta de LinQ se debe usar siempre el nombre de variable “item”. Si se requiere anidar más métodos, cada variable de paso deberá tener un nombre descriptivo del elemento de la colección al que hacen referencia. Ejemplo:

listaPaquetes

     .ForEach(paquete => paquete.listaParametros

         .ForEach(parametro => parametro.Nombre));

Uso de Variables

 

Los nombres de las variables debe ser una palabra completa, que indique su significado. Si la variable hace referencia a un acrónimo, se debe escribir completo, evitar abreviaciones, ejemplo:

     var parametroSistema; // Correcto

     var paramSist // Incorrecto

 

Constantes y valores de Solo lectura

 

Todas las cadenas de texto deben declararse como constantes y variables de solo lectura al principio de la clase, según sea el caso. No se deben dejar fijas en el código del método. Esto centraliza todas las cadenas y valores fijos, facilitando su búsqueda y actualización de valor en caso de cambio.

     // Correcto

     Private const string nombreAplicacion = “MiAplicacion”;

     return nombreAplicacion;

     // Incorrecto

     return “MiAplicacion”;

 

Uso de this

 

Las propiedades, métodos, variables, constantes y objetos definidos dentro de una clase siempre deben llamarse con la palabra reservada this, aunque no sea necesario, esto facilita diferenciar cuando es un objeto interno de la clase y cuando es llamada a un objeto o método externo a la clase.