Cómo escribir código legible para ti y para todos (Parte 2)

Como lo mencioné en el posteo anterior Cómo escribir código legible para ti y para todos (Parte 1), el tiempo que los programadores invertimos en lograr descifrar algoritmos o estructurar un código es considerable. Por ello es importante tener en mente ciertos aspectos que pueden ayudarnos a que esto no sea una tarea interminable.

Aquí te presento la segunda parte para que puedas continuar creando programas entendibles y sobre todo estructurados:

Comentar el código

Los comentarios ayudan a documentar el código. Esto es muy importante, ya que aunque nuestra nomenclatura sea muy buena, es necesaria una explicación para entender mejor la lógica de nuestro algoritmo.

Sin embargo, no hace falta explicar cosas obvias; el código fuente en 98% de los casos lo va a leer otro programador o al menos alguien con conocimientos de programación. Un comentario redundante como el siguiente no agrega valor y molesta a la hora de leer código.

Mantener un estándar

La convención de nombres es un conjunto de reglas para la escritura de nombres, código fuente, identificadores y comentarios dentro de la programación que facilitan y hacen más comprensible su lectura.

Por ejemplo, CamelCase propone que los nombres empiecen con minúscula y luego concatenar cada palabra con mayúscula en la primera letra: sumarTotalDescuento().

Es importante el uso de una convención de nombres, ya que al llevar a cabo un estándar es más fácil que a primera vista sepas qué es lo que se está nombrando; por ejemplo, podrás saber si estás viendo una variable o una constante, o si estás invocando una función.

Las más usadas son Camel Case y Pascal Case, pero algunas empresas establecen su propio conjunto de convenciones que satisfacen mejor sus intereses.

Separa el código de los datos

En más de una ocasión me he encontrado con la desastrosa vista de un código lleno de html, php, jquery, conexiones a bases de datos, y todo esto embebido en un solo archivo, lo cual hace sumamente difícil seguirle el hilo al programa.

Si eres de los que aún no se aventura a usar un framework, puedes crear tus propias reglas para usar MVC (Modelo-Vista-Controlador). El punto es separar el código de los programas por sus diferentes responsabilidades.

Debes recordar que un buen programa no solo es el que “funciona”. Siempre busca mejorarlo, hacerlo legible, claro, procura usar funciones y clases para dividirlo en módulos pequeños y fáciles de entender. Todo esto lo hará más funcional, reutilizable y no volverás locos a los programadores a la hora de darle mantenimiento.