#405 · Markdown y documentos

Formateador de texto JSDoc

Limpia y normaliza bloques JSDoc para que las etiquetas y descripciones sean más fáciles de leer. La herramienta conserva tipos y nombres de parámetros, elimina espacios inconsistentes y reconstruye un bloque de comentario válido.

Entrada de texto

Bloque JSDoc
Espacio publicitario

Cómo usar esta herramienta de texto

  1. Pega o escribe el contenido en el área de entrada.
  2. Ajusta las opciones disponibles si necesitas cambiar el comportamiento.
  3. Pulsa el botón principal o usa Ctrl/Cmd + Enter.
  4. Revisa el resumen, las métricas y el resultado antes de copiarlo o descargarlo.

Qué hace esta herramienta

Procesa el contenido con reglas específicas del formato y genera una salida más estructurada o un análisis cuantificable.

El texto se divide en líneas, se reconocen patrones propios del formato y se reconstruye una salida consistente sin modificar identificadores técnicos.

El resultado se genera en tu navegador. Revisa siempre el contenido antes de publicarlo o usarlo en producción.

Ejemplo

Entrada:

/**
* suma dos valores
* @param {number} a primer valor
* @param {number} b segundo valor
* @returns {number} total
*/

Resultado: ejecuta el ejemplo incorporado para ver una salida verificable con las mismas reglas del procesador.

Casos de uso

  • Revisión rápida antes de publicar documentación.
  • Normalización de contenido pegado desde distintas fuentes.
  • Comprobación local sin depender de servicios externos.

Consejos para obtener mejores resultados

  • Usa una entrada suficientemente representativa.
  • Conserva una copia del original antes de reemplazar contenido.
  • Revisa nombres propios, código y valores sensibles tras el procesamiento.
  • Prueba casos límite si el resultado se integrará en un flujo automatizado.

Detalles del procesamiento

El procesamiento se ejecuta localmente con JavaScript y opera sobre el texto visible en el navegador. No requiere una API externa.

El análisis se basa en patrones y no sustituye un parser, compilador o detector especializado cuando se necesita validación normativa completa.

Preguntas frecuentes

¿Cómo puedo alinear etiquetas @param en un bloque JSDoc?

Pega el bloque completo y ejecútalo. Las etiquetas detectadas se normalizan para que sus nombres y descripciones queden más uniformes.

¿Se conservan los tipos entre llaves, como {string} o {Promise<void>}?

Sí. La herramienta no intenta reinterpretar los tipos; mantiene el contenido de la etiqueta mientras ajusta espacios y prefijos.

¿El formateador valida que cada @param exista en la función?

No. Solo da formato al texto JSDoc. La validación semántica requiere analizar también el código de la función.

¿Puedo usar etiquetas como @returns, @throws o @example?

Sí. Las líneas que empiezan por @ se consideran etiquetas y se mantienen en la salida.

¿Qué pasa con las líneas vacías dentro del comentario?

Puedes reducir líneas vacías repetidas con la opción correspondiente para obtener un bloque más compacto.

Resumen de módulos

MóduloFunción
EntradaTexto pegado, escrito o cargado desde archivo
ProcesamientoReglas específicas del tipo de herramienta
SalidaResultado copiable y descargable