LinuxParty

Nunca he conocido a un desarrollador que disfrute escribiendo documentación. Como mínimo entienden su valor y lo escribirán a regañadientes, pero nunca disfrutarán el proceso de escribirlo.

Algunas personas siguen la filosofía de que un buen código debe documentarse a sí mismo, pero si esto fuera cierto, ¿por qué esa persona que está familiarizada con todo el código base es tan valiosa para un equipo? Hay mucho conocimiento, razonamiento y contexto que no se puede deducir simplemente del código sin formato. Una buena documentación que está bien mantenida solo agrega valor y contexto a una base de código.

Esto se aplica particularmente a los lenguajes de programación sin tipo. El único lenguaje que me llama la atención es Python. Aunque se considera extremadamente “legible”, muchas veces me encuentro tratando de deducir el tipo de una variable o parámetro buscando otros lugares en el código donde se usa.

He aquí un ejemplo de un objeto de gramática:

Aquí está el mismo objeto con la documentación con la que vino:

Sin la documentación, es casi imposible deducir el tipo/estructura de la propiedad de las reglas.

AI Doc Writer para Javascript, Typescript, Python y PHP es una extensión de VS Code que genera documentación para usted utilizando AI. La forma en que funciona es que selecciona el código que desea documentar y presiona el botón 'Generar documentos' o presiona el atajo de teclado Cmd / Ctrl +.

Aquí está en acción:

Demostración de AI Doc Writer. Foto cortesía del autor.

Ahora, ¿qué tan bien puede AI entender su código?

Veamos algunos ejemplos.

Aquí está el código de la demostración anterior y la documentación que generó la IA:

La IA proporcionó un resumen conciso de cada función y breves descripciones de los parámetros.

Veamos cómo le va con algo de código Javascript:

Esta salida fue particularmente interesante para mí porque pudo concluir que 15 era divisible por 5 y 3 en lugar de indicar que imprime "FizzBuzz" cuando i es divisible por 15. Entonces, esto me hizo pensar en cómo podría probarlo. — ¿Conoce ecuaciones geométricas simples?

¡Lo hace! No decía "Multiplicar PI con r a la potencia de 2", es decir, no explicaba lo que hace el código palabra por palabra, sino que podía deducir inteligentemente que estas variables estaban calculando ecuaciones geométricas.

En general, AI Doc Writer puede ahorrar mucho tiempo a los desarrolladores al tiempo que aumenta la calidad y la legibilidad de sus bases de código. Brinda a los desarrolladores el poder de explicar de manera inteligente y proporcionar contexto a las funciones y fragmentos de código en menos de un segundo.

Tal vez sea hora de dejar de lado el temor de escribir documentación y dejar que la IA lo haga por usted.
Empezar a usar AI Doc Writer

¡Haz una prueba tú mismo! Dirígete aquí para obtener acceso.

Tweet

Whatsapp