Prompts Maestros logo
Prompts Workflows PRO

Prompt para Generar Documentación JSDoc para Código JavaScript

Genera documentación técnica clara y estándar JSDoc a partir de funciones, clases o módulos en JavaScript.

Este prompt permite generar documentación JSDoc clara y estandarizada para fragmentos de código JavaScript. Es ideal para equipos que requieren consistencia, mantenibilidad y compatibilidad con herramientas modernas.

La versión extendida amplía el detalle con anotaciones avanzadas, ejemplos, typedefs y sugerencias de calidad técnica para proyectos profesionales o escalables.

Actúa como un documentador técnico. Genera documentación estilo JSDoc para el siguiente código. # INFORMACIÓN DEL USUARIO: - Código JavaScript: [CODIGO] - Nivel de detalle deseado: [DETALLE] - Tipo de componente (función, clase, módulo): [TIPO] Devuelve: 1. Comentarios JSDoc listos para pegar. 2. Breve descripción del propósito del código. 3. Parámetros y retorno documentados de manera estándar.
# CONTEXTO: Eres un ingeniero senior especializado en documentación técnica y buenas prácticas de JavaScript. Tu trabajo es generar documentación JSDoc completa, precisa y lista para uso profesional. # INFORMACIÓN DEL USUARIO: - Código JavaScript completo: [CODIGO] - Nivel deseado de profundidad: [DETALLE] - Desea incluir ejemplos con @example: [SI_NO] - Contexto del módulo o librería: [CONTEXTO] - Tipo de anotaciones avanzadas requeridas: [TIPOS_AVANZADOS] # BLOQUES DE RESPUESTA: ## 1. Documentación JSDoc Completa Comentarios listos para copiar en el código, con @param, @returns, @typedef, @throws, @async, @template o lo que aplique. ## 2. Ejemplos de Uso (@example) Solo si [SI_NO] = 'sí'. Incluye ejemplos claros y ejecutables. ## 3. Inferencia de Tipos y Estructuras Explica cómo se derivaron los tipos y estructuras documentadas. ## 4. Sugerencias de Mejora del Código Recomendaciones para claridad, nombrado, modularidad o migración a TypeScript. # CRITERIOS DE CALIDAD: - JSDoc debe ser preciso, coherente y sin inventar funcionalidad.
Este prompt pertenece a la categoría de Programación y Código

¿Qué hace el prompt?

Versión Básica

  • Analiza el fragmento de código JavaScript proporcionado.
  • Genera comentarios JSDoc básicos para funciones y parámetros.
  • Describe propósito, entradas y salidas de manera estándar.
  • Incluye anotaciones simples como @param y @returns.

Versión Extendida

  • Analiza el fragmento de código JavaScript proporcionado.
  • Genera comentarios JSDoc básicos para funciones y parámetros.
  • Describe propósito, entradas y salidas de manera estándar.
  • Incluye anotaciones simples como @param y @returns.
  • Documenta funciones, clases, métodos y módulos con JSDoc avanzado.
  • Infiere tipos complejos, estructuras de datos y retornos.
  • Crea @typedef para objetos, estructuras o parámetros complejos.
  • Incluye ejemplos de uso prácticos con bloque @example.
  • Sugiere mejoras de claridad o diseño para facilitar mantenibilidad.
  • Genera una versión opcional lista para migración hacia TypeScript.

¿Cómo usar este prompt?

Versión Básica

  • Completa las variables con tus datos:
  • [CODIGO] Pega el fragmento completo.
  • [DETALLE] Ej.: 'básico' o 'intermedio'.
  • [TIPO] Ej.: 'función utilitaria', 'clase', 'módulo de API'.
  • Ejecuta el prompt y copia los comentarios JSDoc directamente a tu código.

Versión Extendida

  • Rellena las variables según tu caso:
  • [CODIGO] Pega el fragmento completo.
  • [DETALLE] Ej.: 'avanzado', 'compatible con TS-check'.
  • [SI_NO] Ej.: 'sí'.
  • [CONTEXTO] Ej.: 'utilidades de backend', 'capa de API'.
  • [TIPOS_AVANZADOS] Ej.: '@typedef', '@template'.
  • Ejecuta el prompt y pega la documentación directamente en tu archivo .js o .mjs.

Tips

Versión Básica

  • Pega el código completo y bien formateado para evitar errores.
  • Indica si deseas solo documentación o también una breve explicación.
  • Aclara si el código usa funciones, clases o módulos.
  • Solicita que el estilo sea compatible con VSCode o TypeScript si lo necesitas.

Versión Extendida

  • Aporta el contexto del módulo para generar mejores @typedef.
  • Indica si deseas ejemplos detallados o concisos.
  • Puedes solicitar que las anotaciones sigan estándares de TS-check.
  • Si tienes múltiples funciones, pide documentación por secciones.