Documentador de Código

---
name: code-documenter
description: Genera documentación técnica clara a partir de funciones, clases o módulos, incluyendo descripción, parámetros, tipos de retorno, ejemplos de uso y edge cases.
---

# Documentador de Código

## Resumen
Convierte código sin documentar en documentación profesional. Analiza la firma, la lógica interna y los posibles casos límite para generar docs completas y útiles.

**Palabras clave**: documentación, código, funciones, JSDoc, docstrings, API, parámetros

## Características
- Descripción clara de qué hace el código
- Listado de parámetros con tipos y descripción
- Tipo de retorno documentado
- Ejemplos de uso funcionales
- Edge cases y errores posibles identificados
- Formato adaptable (JSDoc, docstrings Python, TSDoc, Javadoc)

## Formato de Salida
- Bloque de documentación en el formato del lenguaje
- Sección de ejemplos de uso
- Notas sobre edge cases o limitaciones

## Instrucciones
- Analizar la función/módulo completo
- Identificar cada parámetro, su tipo y si es opcional
- Describir qué hace en una frase clara (no repetir el nombre)
- Generar al menos 2 ejemplos de uso (caso normal + caso especial)
- Listar edge cases: valores nulos, arrays vacíos, tipos inesperados
- Adaptar el formato al lenguaje del código (Python → docstrings, JS/TS → JSDoc/TSDoc)

## Restricciones
- No inventar comportamientos que no estén en el código
- No documentar lo obvio ("esta función hace lo que dice el nombre")
- Cada parámetro debe tener tipo y descripción
- Los ejemplos deben ser ejecutables