Consejos para mantener tu código limpio

Código legible es software mantenible


En mi canal de youtube publiqué un vídeo donde presenté 11 consejos para que tu código sea más legible, ahora en este artículo ampliaremos algunos puntos.

Hay que darnos cuenta que código legible significa un software de fácil mantenimiento.


El objetivo como un desarrollador de software es construir un software bueno, útil y mantenible. Una condición para que tu software resulte bueno, útil y mantenible es escribir código de calidad. Puedes crear un sistema con código basura en dos días pero darle mantenimiento va a ser una pesadilla. Y si estás en un equipo la situación requiere que todos los desarrolladores en el equipo, sin importar nivel o habilidades, pueda entender y leer el código que otro haya realizado. .

Quitar código comentado y comentarios innecesarios


Acá hay dos cosas, que me ha pasado y es tener código comentado desde el año de la pera y comentarios innecesarios que no ayudan a entender el código.

El código comentado es un problema para entender el código, a veces tienes que buscar palabras clave o código para detectar un error y te encuentras con varios resultados pero el 90% de ellos son parte de código comentado. BORRALO. BORRALO, BORRALO. Si tienes un control de código fuente ya estará guardado ahí, y si no lo tienes, pues ¿ya es hora, verdad?, ya deja de ser un coleccionista de chatarra virtual.

Nombrar variables y objetos debe ser tu pasión


Variables y objetos con nombres crípticos incrementan la dificultad para entender que es lo que hace el código.  Considera que nombrar de forma adecuada y reconocible a tus variables te ayudará a que en el futuro entiendas de donde viene el valor que estaba en la variable AX23. A veces cuesta, lo sé, porque a veces me toma un par de minutos bautizar de forma adecuada a una propiedad o clase, pero sirve luego para saber su función o objetivo.

Salida temprana


A esto no me refiero a salir temprano del trabajo, por cierto, siempre me indigna que en algunas empresa digan "estás saliendo temprano" cuando estás saliendo en tu hora de salida. Son empresas que solo te reconocen las horas que trabajes, sin importar si hiciste algo provechoso. Te aprecian más si te la pasas quince horas sentado en la oficina haciendo vida social que cumpliendo tu horario y trabajando a conciencia. Huye de esas empresas.

Volviendo al tema del código, respecto a salida temprana me refiero al tema de ejercer ciertas condiciones para que salgas de una función lo más temprano posible sin caer en un error.

Por ejemplo:
public bool Validar(Cliente cliente)
{
if(cliente == null) {
return false;
}
if(string.IsNullOrEmpty(cliente.nombre))
{
return false; 
}
/*aqui viene el código que procesa la propiedad nombre de cliente */

El código puede funcionar bien, pero los dos IF pueden resumirse en uno solo.
public bool Validar(Cliente cliente) { 
if(cliente == null && string.IsNullOrEmpty(cliente.nombre))
{
return false;
}

/* aquí viene el código que procesa la propiedad nombre de cliente */

}

De esa forma se validan las dos condiciones a la vez y se evita que se ejecute cualquier otro código antes.

La regla del boyscout


Déjalo mejor de lo que estaba. Esa es la regla. Si consideras que el código está desordenado o confuso, límpialo, ordénalo. Refactoriza, quita ese comentario inútil, quita esa variable que no sirve de nada. Quita ese IF imposible.

Programa con estilo


No me refiero a programar bien vestido. Me refiero a determina un estilo de código en tu equipo. Utiliza tabulaciones, espacios, constantes en mayúsculas o minúsculas, etc. Sigue un estilo único y fácil de leer. Un sólo estilo de trabajo, para que todos entiendan, y si un nuevo programador entre al equipo, lo lea y se adapte de forma rápida.

Conclusión


Sé que he repetido varias cosas que ya dije en el vídeo, pero pensé que era válido incidir en esos puntos. Algunos son obvios otros no tanto, y sé que no siempre trabajamos en el mismo código fuente, el sistema de ventas tiene un código diferente del sistema de almacén, pero es importante mantener el código limpio en sistemas pequeños y mucho más en sistemas más grandes.

Hay muchos artículos en la red que hablan de lo mismo que escribo aquí, la idea es enseñar lo bueno.

Comentarios