Seis tips para escribir código mantenible

Como desarrollador, sabemos que el tiempo es un recurso muy valioso. Estos seis tips sobre cómo escribir código mantenible están garantizados para ahorrarte tiempo y frustraciones: un minuto gastado en la escritura de comentarios puede ahorrarte una hora de angustia.

1. Comenta tu código como lo hace una persona inteligente

Es obvio. Si escribes un procedimiento y en pocos meses después falla al ejecutarlo, y entonces revisas el código para retrabajarlo y si no lo tienes comentado te costará tiempo. Este tiempo es un recurso tan valioso que nunca puede ser recuperado.

2. Usar el #define

La mayoría de los programadores sabemos hacer cosas como esta. Pero se requiere de disciplina para hacerlo. Cada vez que definas una constante deberías definirla en un lugar centralizado. Por ejemplo, si tu quieres que el área del layout de tu pagina web sea de 800 x 600 pixeles:

#define PIXEL_WIDTH_LAYOUT	800
#define PIXEL_HEIGHT_LAYOUT	600

Si después decides cambiar el tamaño, solo lo tendrías que cambiar aquí y no tendrías que buscarlo en todo tu código y también, no tendrías que componer errores causados por las referencias perdidas.

3. No usar nombres de variables que te puedan burlar después

Si alguien no tiene idea la leer un nombre de variable, no puede entender lo que está haciendo. Una buena estrategia es dar nombres descriptivos a las variables, procedimientos, clases, etc.

4. Hacer verificación de errores

Cuando alguien crea un procedimiento/función debería siempre pensar, “Suponer a alguien malévolo, que por ejemplo use valores extraños, ordene los datos al revés, introduzca valores inválidos, etc; ¿cómo podemos proteger el código y defenderlo para conservar el sistema de que no truene?”

5. Optimización prematura es la raíz de todo mal

La regla es codificar claro y que trabaje bien. Tu tendrás el tiempo para optimizarlo después. Pero no lo hagas hasta que estés seguro de lo que lo que estas haciendo es lo correcto.

6. No ser demasiado listo, en gran parte

Cada quien tiene su propia tolerancia para la complejidad del código. En la codificación de programas, la regla es buscar que se gaste menos tiempo en tratar de comprenderlo, tanto para ti como para las personas que lo lean.