Asistente de IA para comentarios de código y documentación en línea. Redacta JSDoc, docstrings, comentarios de documentación XML y explicaciones de código en línea que mejoran la legibilidad del código base y generan referencias de API precisas.
La documentación en línea —los comentarios y docstrings que residen directamente en el código fuente— es la forma más leída de documentación técnica en ingeniería de software, y la más descuidada. Cuando está bien escrita, la documentación en línea hace que un código base sea drásticamente más rápido de navegar, revisar y ampliar. Cuando está ausente o mal redactada, obliga a los desarrolladores a realizar ingeniería inversa de la intención a partir de la implementación cada vez que se encuentran con código desconocido. Este asistente de IA ayuda a los ingenieros de software a escribir documentación en línea que sea precisa, coherente y genuinamente útil para el próximo desarrollador que lea el código.
El asistente se especializa en las convenciones de documentación y formatos de anotación utilizados en los principales lenguajes de programación y ecosistemas. Para JavaScript y TypeScript, escribe comentarios JSDoc con anotaciones de tipo precisas, descripciones de parámetros, documentación de valores de retorno y bloques de uso de ejemplo que se integran con generadores de documentación como TypeDoc. Para Python, escribe formatos de docstring NumPy, Google y reStructuredText según la convención del proyecto, cubriendo parámetros de funciones, valores de retorno, excepciones lanzadas y ejemplos de uso. Para Java y C#, produce comentarios de documentación Javadoc y XML que generan documentación de referencia de API precisa.
Más allá del cumplimiento del formato, el asistente se centra en la sustancia de lo que hace valiosa la documentación en línea: explicar el porqué detrás de decisiones no obvias, documentar precondiciones y postcondiciones que los llamadores deben respetar, señalar casos límite y limitaciones conocidos, y describir algoritmos complejos en lenguaje sencillo que haga el código comprensible sin leer cada línea. Evita el fallo más común de la documentación en línea: comentarios que repiten lo que el código ya dice sin añadir comprensión.
El asistente también ayuda a establecer y hacer cumplir guías de estilo de documentación para equipos de ingeniería, redactar encabezados de documentación a nivel de módulo y archivo, documentar expresiones regulares complejas y objetos de configuración, y revisar la documentación en línea existente para verificar su integridad y precisión.
Este asistente es ideal para ingenieros de software que documentan código que están escribiendo o revisando, equipos que establecen estándares de documentación en línea, mantenedores de bibliotecas de código abierto que generan documentación de referencia de API y líderes de ingeniería que realizan revisiones de calidad de documentación.
Sign in with Google to access expert-crafted prompts. New users get 10 free credits.
Sign in to unlock