Explicando código con arte ASCII

Una imagen dice más que mil palabras. Esto también es cierto cuando se trata de explicar tu código.

Aquí hay otro ejemplo de cómo la documentación aumenta el valor de tu código. John Regehr recopiló imágenes de cómo en algunos proyectos de código abierto se usa arte ASCII para explicar el código de manera más clara.

En su artículo, escribe:

Las personas tienden a ser visuales: usamos imágenes para entender problemas. Los lenguajes de programación más populares, por el contrario, operan en un espacio completamente abstracto, dejando una gran brecha entre programa e imagen.

Un ejemplo tomado del compilador de Swift:

Puedes utilizar apps como Mondraw para crear este tipo de documentación. Recuerda el Triángulo de la Documentación de Código, y que agregar documentación no es una admisión de que no fuiste lo suficientemente inteligente para escribir “buen” código.

 

Soy Oscar Swanros.

En este blog y en mi newsletter exploro cómo los desarrolladores de software pueden crear carreras profesionales más humanas y sostenibles.

Haz clic aquí para conocer más →