5 tips para escribir mejor código (con ejemplos en Python)

Foto de Blake Connally extraída de Unsplash

Como programadores no solo tenemos que escribir código, sino también leerlo. En ocasiones tendremos que leer el código que escribimos meses o años atrás, o serán otros programadores que leeran nuestro código. Es por ello que no solo es importante que nuestros programas corran sin errores sino que deben estar bien escritos.

Es así que en este artículo, daré algunos tips para escribir código limpio. Estos tips son aplicables a cualquier lenguaje de programación, pero los ejemplos están en Python.

1. Usar indentación o saltos de línea para hacer más legible el código

Una buena práctica es identar nuestro código para llevar separar bloques de código y visualizar la estructura. En algunos lenguajes es obligatoria la indentación como en Python mientras que en otros no. Muchos editores de texto ofrecen la opción para indentar el código automáticamente. Otra buena práctica es dividir el código en distintas líneas en vez de tener una sola línea muy extensa.

2. Usa nombres descriptivos para variables, funciones, parámetros,etc.

Los nombres deben ser descriptivos para que puedan ser entendidos por otras personas a parte de quien hizo el código. El nombre de la variable debe sugerir lo que esta almacena al igual que el nombre de la función debe dar una idea clara de qué tarea lleva a cabo.

3. Captura y maneja las excepciones.

Normalmente cuando ocurre un error en la ejecución, el programa se detiene y esto no sería bueno si el código ha sido desplegado y tiene usuarios. Por ello, es recomendable prever los posibles errores que podrían aparecer en la ejecución.

4. Saber cuándo documentar y cuándo no documentar.

Una buen práctica es documentar todas las funciones. Para ello se debe indicar qué parámetros acepta, de qué tipo y qué se asume de estos. También se puede colocar qué retorna y qué tarea ejecuta. Una mala práctica es comentar líneas de código donde la operación que se está ejecutando resulta bastante obvia.

5. Cada función o método debe ejecutar una sola tarea.

Las funciones deben ser predecibles y para ello se recomienda que solo se encarguen de una sola tarea. A esto se le conoce como el Single Responsibility Principle (SRP).