Para algunos, escribir documentación es la peor parte de la programación. No hay una recompensa real por completarlo, y lleva demasiado tiempo asegurarse de que todo esté descrito correctamente.
Sin embargo, es extremadamente importante para la salud de cualquier programa que se tome el tiempo para documentarlo detallando cada proceso y línea de código.
Escribir y documentar el código no es solo una cortesía para tu compañero programador (o tu futuro reemplazo). Es necesario tener una comprensión profunda del código que está escribiendo. Si no sabes qué línea de código hace qué, es posible que en el futuro te recuerdes a ti mismo a tu progenitora.
Si no han documentado su código, les resultará difícil corregir errores y realizar actualizaciones más adelante.
Si eres igual de flojo que yo, buscaras maneras de realizar el proceso de documentación más rápido o incluso saltártela.
Afortunadamente, para ti y para mí, existe una herramienta que utiliza la inteligencia artificial que es capaz de auto generar documentación a partir de código fuente.
Existe esta extensión bastante nueva de VS Code llamada AI Doc Writer para JavaScript, TypeScript y Python.
Para generar la documentacion automaticamente solo sedeben seguir los siguientes pasos:
Así es como le fue en algún código JS:
Cursos de Excel gratuitos: aprende desde cero, domina funciones avanzadas y mejora tu perfil profesional…
El cupón EDC42D3C5ADA43D7A1EB te da acceso gratis a un curso que normalmente cuesta 349 MX$,…
Para aprovechar esta oferta, solo tienes que usar el cupón 65F70E99E3CE22D8F162 antes de que termine.
Para obtener este curso gratis, solo debes usar el cupón E0AE933B729DEE27A5DE antes de que termine…
Descubre los cursos gratuitos de la UNAM en Aprendo+: formación online en Excel, finanzas, salud…
Harvard ofrece cursos gratuitos. Aprende IA, programación, liderazgo y más con profesores de élite mundial…