Por qué deberías escribir el código como si fuera poesía y 10 consejos de un programador

PBTF1NEBCG
Julian Builes, VP de ingeniería de Morsel ofrece 10 consejos a los desarrolladores al momento de escribir código.

El buen código es tan legible como la prosa.

La gran mayoría de desarrolladores no se percatan que a través de su camino como creadores de software también se convierten en escritores. Desarrollan un vocabulario característico, patrones de puntuación e indudablemente su propio estilo narrativo. Puedes preguntarle a cinco escritores que cuenten la misma historia y el resultado será diferente para cada uno de ellos. De la misma manera, puedes pedirle a cinco desarrolladores que escriban el mismo algoritmo y te garantizo que su código será diferente en más de una manera.

Esto se debe a que el código que escribimos es una reflexión de nuestros pensamientos y del proceso mental que transcurre mientras llegamos a ellos. Este proceso es diferente para cada uno de nosotros y causa que nuestro código sea completamente diferente.

Es precisamente por esto que necesitamos narrar nuestras historias de una manera que le permita a otros entenderlas fácilmente, o dicho de otra manera, debemos escribir código que sea legible. Aunque las pautas varíen de un lenguaje de programación a otro, el principio subyacente es el mismo: escribe código que otros desarrolladores puedan leer.

Estos 10 tips que he compilado te ayudarán a escribir poesía en tu lenguaje de programación favorito:

1. Permite que el código se describa a sí mismo

Escribe código que sea auto-descriptivo de manera que no sea necesario documentarlo.

Screen Shot 2015-08-05 at 5.41.35 PM

2. Sé sabio al elegir nombres

Opta por nombres que sean concisos, pero al mismo tiempo explícitos acerca de lo que representan.

Screen Shot 2015-08-05 at 5.50.03 PM

3. Asume que estás escribiendo para alguien más, ¡siempre!

Incluso aunque este no sea siempre el caso, considero personalmente que ésta es una buena costumbre para motivarme a escribir código que otros desarrolladores se deleiten de leer, o quizás yo mismo en un par de meses 🙂

4. Apóyate en las pautas estilísticas y convenciones de tu lenguaje

Conviértete en un conocedor de las mejores prácticas y estándares de tu lenguaje de programación. Sigue las guías estilísticas y convenciones de nombres. En mi caso visito esta guía estilística de Swift frecuentemente para inspiración.

5. Evita abreviaciones crípticas

¡Déjale los jeroglíficos a los egipcios! Ellos lo hacían muy bien y estaban de moda en su momento. Evita la tentación de abreviar nombres para ahorrar espacio o ‘keystrokes’. Utiliza abreviaciones sólo cuando elimines la posibilidad de una ambigüedad.

Screen Shot 2015-08-05 at 5.50.48 PM

6. Sé consistente con tu indexación

Por insignificantes que parezcan, la indexación y los espacios son dos de los factores que más contribuyen para escribir código que sea legible y hasta bonito. Asegúrate que la configuración de tu IDE sea consistente en todos tus equipos y coordina con tu equipo de desarrollo para crear un estándar en dicha configuración.

Screen Shot 2015-08-05 at 5.52.07 PM 

7. Aprovecha nuevos renglones para agrupar código relacionado

Screen Shot 2015-08-05 at 5.52.16 PM

8. Ataca complejidad descomponiéndola

Uno de los motivos por los cuales fragmentos de código suelen ser difíciles de interpretar es por su nivel de complejidad. Esto es especialmente cierto en piezas de autenticación o computaciones laberínticas.

La mejor manera de mitigar esta complejidad es descomponiéndola en piezas más manejables. Esto puede lograr que tu código sea un poco más extenso, pero al mismo tiempo lo hará más legible y manejable.

Screen Shot 2015-08-05 at 5.56.58 PM

9. Explota los ‘return statements’

Una vez que una función llega a una declaración de ‘return’, tú como desarrollador paras de leer. Si tienes esto en cuenta en el momento de escribir funciones, eliminas la necesidad de leerlas en su totalidad si ubicas ‘return statements’ en los puntos inflexivos de tu lógica.

Screen Shot 2015-08-05 at 6.00.28 PM 

10. Documenta sólo cuando sea necesario

Aunque documentar tu trabajo es un hábito excelente, excederse en ello no lo es. En algunas ocasiones me he encontrado con código que ha sido documentado innecesariamente. Esto incrementa la cantidad de texto que tenemos que leer y código que mantener.

Screen Shot 2015-08-05 at 6.01.24 PM

Acerca del autor

Julian Builes

Emprendedor y desarrollador iOS Colombiano, estudió Computer Science en Hofstra University (Hempstead, New York). Cofundador de CanIEat, un emprendimiento en el sector de comida en Kansas City. Ganador del primer lugar en Kansas City Startup Weekend 2012 con Wazoo. Trabajó en el equipo de Cloud Security Infrastructure en Cerner Corporation (CERN) la empresa más grande del mundo en el sector tecnológico de la salud, y fue parte del equipo técnico y estratégico de Netchemia (adquirido por PeopleAdmin este año). Julián actualmente es VP of engineering en Morsel, un emprendimiento que busca llevarte a tu puerta los platos más saludables y de la más alta calidad de la manera mas fácil posible.