Prompts Maestros logo

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

Compatible con ChatGPT, Gemini, DeepSeek, Grok, Claude, Perplexity y otros modelos.
Genera documentación técnica clara y estándar JSDoc a partir de funciones, clases o módulos en JavaScript.
programacion javascript documentacion jsdoc codigo ingenieria-de-software mejores-practicas refactorizacion tutorizacion
Cargando prompt...
Categoría: Prompts para Datos y Análisis
Subcategoría: Prompts para Programación y Código

¿Qué hace el prompt?

  • 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.
  • PRO
     Documenta funciones, clases, métodos y módulos con JSDoc avanzado.
  • PRO
     Infiere tipos complejos, estructuras de datos y retornos.
  • PRO
     Crea @typedef para objetos, estructuras o parámetros complejos.
  • PRO
     Incluye ejemplos de uso prácticos con bloque @example.
  • PRO
     Sugiere mejoras de claridad o diseño para facilitar mantenibilidad.
  • PRO
     Genera una versión opcional lista para migración hacia TypeScript.

¿Cómo usar este prompt?

  • 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.

Tips

  • 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.

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 PRO amplía el detalle con anotaciones avanzadas, ejemplos, typedefs y sugerencias de calidad técnica para proyectos profesionales o escalables.