Documentación de función de código
Genera documentación clara (docstring/JSDoc) para una función a partir de su código, incluyendo parámetros, tipo de retorno y un ejemplo de uso listo para copiar.
Actúa como ingeniero de software encargado de la documentación técnica del proyecto. Genera la documentación de la siguiente función en formato [JSDoc / docstring de Python / Javadoc / etc.], incluyendo: descripción breve de qué hace la función y por qué existe, cada parámetro con su tipo y propósito, el valor de retorno con su tipo, posibles excepciones o errores que puede lanzar, y un ejemplo de uso realista. Código: [PEGA AQUÍ LA FUNCIÓN]
Caso de uso
Documentación técnica
Documentar código es una de las tareas que más se posponen en equipos de desarrollo. Este prompt reduce la fricción al generar un primer borrador completo (descripción, parámetros, retorno, ejemplo) que el desarrollador solo necesita revisar y ajustar, en vez de escribir desde cero.
Por qué funciona esta estructura
La técnica aquí es pedir todos los componentes estándar de una buena documentación de una vez: qué hace, por qué existe, parámetros con tipo, retorno con tipo, excepciones posibles y un ejemplo de uso. Ese último punto, el ejemplo realista, es el que más suele faltar en documentación escrita manualmente bajo presión de tiempo, y sin embargo es el que más ayuda a otro desarrollador a entender rápidamente cómo usar la función sin tener que leer el código completo.
Antes vs. después
Antes: pedir documenta esta función suele generar solo una línea descriptiva genérica del tipo esta función calcula un valor, sin detalle de parámetros ni ejemplo de uso.
Después: con la estructura completa, la misma función de cálculo de impuestos queda documentada con cada parámetro explicado (monto: número decimal representando el importe base en euros), el tipo de retorno especificado, una nota sobre la excepción que lanza si el monto es negativo, y un ejemplo de código listo para copiar y pegar en la consola.
Variaciones útiles
- Para librerías de uso público: pide que incluya también una nota de desde qué versión existe la función y si hay alguna alternativa recomendada si está marcada como obsoleta.
- Para funciones con efectos secundarios (side effects): pide que documente explícitamente qué modifica la función además de su valor de retorno, como escribir en una base de datos o modificar un archivo.
- Para onboarding de nuevos desarrolladores: pide una versión con más contexto narrativo, explicando también en qué parte del sistema se usa típicamente esta función.
Qué IA usar
ChatGPT y Claude son igual de competentes para esta tarea rutinaria de documentación. La diferencia práctica suele estar en la integración: si ya usas Claude o ChatGPT dentro de tu editor de código a través de una extensión, es más eficiente mantenerte en esa misma herramienta para todo el flujo de documentación.
Publicidad
Conclusión
La documentación generada es tan buena como el código que describe: si la función tiene nombres de variable poco claros, revisa también el propio código antes de documentarlo. Documentar no debería ser el último paso olvidado del desarrollo, y automatizar el primer borrador reduce la excusa más común para saltárselo.
Preguntas frecuentes
Explora más prompts en Programación y código o revisa nuestras guías de prompt engineering.
Prompts relacionados
Revisor de código con buenas prácticas
PremiumPide una revisión de código detallada señalando bugs, riesgos y mejoras de legibilidad. Funciona como un segundo par de ojos disponible en cualquier momento, útil tanto para revisiones rápidas como para preparar código antes de un pull request.
Generador de tests unitarios
Genera casos de prueba unitarios para una función, incluyendo casos límite habitualmente olvidados como valores nulos, vacíos o extremos que el camino feliz suele pasar por alto.
Explicación de código para principiantes
Explica un fragmento de código línea por línea en lenguaje sencillo, ideal para quien está aprendiendo a programar o necesita entender rápidamente código heredado de otro desarrollador.