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

¿Alguna vez te ha pasado que te solicitan corregir un error o agregar un módulo nuevo a algún proyecto realizado por alguien más? Lo último que quieres encontrar es un espagueti de código sin pies ni cabeza.

Es increíble el tiempo que los desarrolladores invertimos en el simple hecho de descifrar algoritmos creados por alguien más. Por esta razón, es muy importante crear código que sea legible para otros programadores, incluso para nosotros mismos, mediante buenas prácticas de programación.

Cualquiera que sea el lenguajeque vas a usar, los principios son básicamente los mismos.

A continuación te comparto algunos consejos para crear programas entendibles y bien estructurados:

Indexación del código fuente

Mantén el código ordenado. Aplica tabulaciones para que las distintas secciones queden bien separadas a simple vista. Por insignificante que parezca, la indexación y los espacios son los dos factores que más influyen a la hora de escribir código legible.

Hoy en día la mayoría de los IDEs traen agregada alguna opción para formatear tu código automáticamente, o incluso existen herramientas online para indexar código en el estilo que más te guste.

Nomenclatura coherente

Procura usar nombres descriptivos para tus variables, clases, métodos y funciones de tal forma que a simple vista se pueda saber de qué se trata o para qué sirven.

Los nombres afectan mucho en la interpretación que se le da al código fuente; por ejemplo, si tienes una variable llamada “sum” podrías entender que esta almacena una suma. Sin embargo, en programación es mejor ser más específicos. La idea es darle al lector la mayor cantidad de información posible sin necesidad de depender del contexto. Por lo tanto, si llamamos a la variable “sumaNotas” en lugar de “sum”, el lector podría entender mejor la función de esta variable.