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:
- Paso 1 Resalte el código
- Paso 2 Haga clic en el botón “generar documentacion” (o presione ⌘ + .)
Así es como le fue en algún código JS:
📝 Lenguajes soportados actualmente
- JavaScript
- TypeScript
- JSX and TSX files
- Python
Más en: Inteligencia Artificial
