5 razones para documentar nuestro código

Documentar nuestro código mientras codificamos puede ser unas de las tareas más tediosas que existan para un desarrollador. Sin embargo, tomar la documentación como costumbre puede, por más increíble que suene, acelerar el proceso de construir una aplicación.

No importa si desarrollas dentro de un equipo de desarrolladores o si eres un desarrollador independiente, el documentar tu código te va a ayudar grandemente a en tus proyectos futuros por estas 5 razones.

1. Ayuda a entender nuestro código

Cuantas veces hemos revisado nuestro código que hemos escritos días o semanas atrás y hemos dicho, ¿que rayos yo estaré haciendo aquí? Probablemente muchas. Y luego tienes que descifrar en que estabas pensando en aquel momento y pensar porqué codificaste de la forma en que lo hiciste.

Con una buena documentación del código te hubieses evitado pasar los próximos 30 minutos o más pensando en lo que hiciste y por que lo hiciste.

2. Ayuda a los demás

Si perteneces a un equipo de desarrollo donde tienes que compartir tu código con varias personas estarías ayudando a los demás. Ya no tienen que acudir a ti a preguntarte cómo o porqué hiciste lo que hiciste sino que, ahora, simplemente, leen tu documentación y continua el proceso. Le ahorras tiempo a ellos y a ti que puede utilizarse en tareas más importante.

3. Te ayuda a corregir errores fácilmente

Además de ayudarte a recordarte qué y cómo hiciste las cosas en el código, también, te ayuda a corregir los errores con más facilidad. Ya no tienes que ir buscando dónde en el código haces una u otra cosa, ahora sabes exactamente que pedazo de código hace lo que estas buscando. Simplemente buscas en la documentación el pedazo de código que está causando problemas y lo resuelves.

4. Mantiene claro el objetivo

Muchas veces me ha pasado que encuentro pedazos de código que no tienen ninguna función y no recuerdo porque escribí eso. Probablemente también te ha pasado a ti. Si es así, el documentar te ayudará a mantener el objetivo siempre claro.

Si ese pedazo de código era importante o lo habías escrito para hacer una prueba, la documentación te lo habría informado. Solo basta con leerla.

5. El código se vuelve reutilizable

Es posible que, según vamos codificando, necesitemos hacer algo que anteriormente habíamos hecho. En lugar de ir mirando nuestro código buscando lo que necesitamos, acudimos a la documentación para encontrar fácilmente lo que nos hace falta.

Resumen

Documentar nos va a servir de guía para leer nuestro propio código. Nos va a ahorrar tiempo a nosotros mismo y también a nuestros compañeros de trabajo. Es un buen habito que debemos adoptar tanto personalmente como grupal.

Deja tu comentario