Documentación de función de código
Genera documentación clara (docstring/JSDoc) para una función a partir de su código.
Prompt
Genera la documentación de la siguiente función en formato [JSDoc / docstring de Python / etc.], incluyendo: descripción breve de qué hace, cada parámetro con su tipo y propósito, el valor de retorno, y un ejemplo de uso. 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.
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.
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.
ChatGPTClaude
Generador de tests unitarios
Genera casos de prueba unitarios para una función, incluyendo casos límite habitualmente olvidados.
ChatGPTClaude
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.
ChatGPTClaudeGemini