¿Cuantas veces te ha pasado de heredar un código y encontrarte con un sinsentido de código, una locura? pero tu como programador web lo ultimo que quieres encontrarte es un código espagueti, eso para ti sera lo peor.

no, lo peor es que ese código ilegible no sea de otra persona, lo peor es retomar un código tuyo de hace meses y que para ti ya no tenga ningún sentido.

Ya sabes cuanto tiempo puedes emplear a descifrar tu propio código y el de otras personas, encima si eres autónomo estas regalando tu tiempo al cliente. Por esta razón, es muy importante crear código legible para otros compañeros programadores, pero lo mas importante para ti mismo, el código legible se consigue mediante buenas prácticas de programación y mucha costumbre, al principio te parecerá una perdida de tiempo.

Aunque nosotros nos estamos especializando en la programación web, realmente no importa el lenguaje que estés usando. Los principios de la programación con código legible son los mismo.

A continuación te comparto un podcast de un gran tipo que sigo que habla de código legible y limpio con los principios s.o.l.i.d:

Identar el código código es lo mas importante para tener un código legible

A pesar que ya se sabe y que la mayoría de los IDE’s de desarrollo ya lo hacen, pero esfuérzate para que tu código sea limpio, este ordenado y este debidamente tabulado esto como no tiene un nombre, taººbular o espaciar el código para crear un código limpio se llama identar el codigo.

Manten tu codigo devidamente identado, esto hara que las diferentes secciones del codigo quede ordenado por bloques y a simple vista decidir donde empieza y acaba un bucle, un if o un metodo.

Mantén una nomenclatura coherente al nombrar.

Evita usar nombres poco descriptivos cuando estemos creando el codigo, cuesta lo mismo llamar a una variable x, que inicializadoraBucle o llamar a una funcion verificar(), que verificarEmail()

Los nombres a nuestros objetos, variables, metodos dan sentido al codigo y y con un vistazo rápido nada mas abrir el archivo podremos saber de que se trata.

Comentar el código pero con moderación

Tan malo es comentar poco como no comentar nada o peor aun, sobre comentar tu código

Al inicio del documento es muy recomendable esciribir un pequeño comentario, como son

  • La versión del código.
  • Una descripción de la finalidad del código.
  • Una descripción del uso de las variables.
  • Una explicación para el uso del código.

Los comentarios son importantes para documentar el código. Aunque el código sea poco legible, las nomenclaturas no sean las correctas. comentando el código y utilizando las descripción del inicio del código podremos conseguir entender y hacer funcionar el código sin problemas.

Pero como ya he dicho, no es necesario comentar linea a linea todo lo que se hace. sobre comentar solo engordara el tamaño del archivo.

Mantener un estándar facilita la escritura de un código limpio y legible

No importa el lenguaje de programación o el framework de moda que estés utilizando para crear tu código limpio, lo importante es leer la documentación, para saber como nombrar las variables, funciones y mantener siempre un estándar a la hora de escribir el código

Seguro que has visto por ahí nombres de variables que empiezan en minúscula y las siguientes palabras se concatenan en mayúsculas esto se llama camelCase.

El nombre de una funcion siguiendo una convencion camelCase para crear un codigo limpio, podria ser validarEmailNuevoRegistro()

Las más usadas son Camel Case y Pascal Case, de todas formas algunas empresas imponen su propio conjunto de convenciones esto puede llegar a ser un problema, ya que si este codigo es entendible solo para esa empresa y cuando alguien nuevo entra tiene que aprender toda la nueva convencion.

Separa el código de los datos

No han sido pocas las veces que te habrás encontrado con el famoso código espagueti, código php embebido en html con el jquery por ahí dando vueltas y estilos embebidos directamente en los bloques.

Son pesadillas hechas realidad, créeme y es muy normal. Una posible solución es el uso de un framework que haga uso del MVC, eso si. No te vengas arriba y crees tu propio framework porque aprender uno es muy complicado invertirás mas horas en mantenerlo que las horas que te quitara.

MVC (Modelo-Vista-Controlador). significa separar:

  • El Modelo es el encargado de llamar a las bases de datos.
  • La vista es el encargado de pintar todo y mostrar la vista al usuario.
  • El controlador es el encargado de unir las llamadas del modelo y decirle a la vista los valores a dibujar.

Recuerda que lo importante no es que funcione, sino poder mantener el tiempo en el tiempo y esto solo se consigue mantener con un código legible

Busca mejorar continuamente en tu trabajo procura hacer un código legible, nombrando tus funciones y variables correctamente

Tags: