Categorías

← View All Tools

Extractor de Docstrings

Extrae y analiza documentación de código fuente JavaScript/TypeScript, Python y Java

Características

Extrae documentación de múltiples lenguajes de programación:

  • JSDoc: Comentarios de documentación JavaScript y TypeScript
  • Docstrings Python: Documentación de funciones y clases con comillas triples
  • JavaDoc: Comentarios de documentación Java con etiquetas estándar

Extracción

Extrae metadatos completos de documentación:

  • Nombres de funciones/clases: Identificadores de símbolos
  • Descripciones: Texto principal de documentación
  • Parámetros: Etiquetas @param con nombres, tipos y descripciones
  • Valores de retorno: Etiquetas @return o @returns
  • Excepciones: Etiquetas @throws, @exception o secciones raises
  • Ejemplos: Etiquetas @example o bloques de código de ejemplo
  • Números de línea: Ubicación en el código fuente
  • Visibilidad: Miembros públicos, privados o protegidos

Análisis

Analiza patrones de documentación comunes:

  • JSDoc: /** ... */ con @param, @return, @throws
  • Python: """...""" con secciones Args, Returns, Raises
  • JavaDoc: /** ... */ con @param, @return, @throws

Índice

Genera un índice de documentación buscadle:

  • Nombres de símbolos para búsqueda rápida
  • Categorización por tipo (funciones, clases, métodos)
  • Métricas de completitud de documentación
  • Recuento de ejemplos, parámetros y tipos de retorno

Incluir comentarios de documentación originales completos

Datos clave

Categoría
Development
Tipos de entrada
textarea, select, checkbox
Tipo de salida
json
Cobertura de muestras
4
API disponible
Yes

Resumen

El Extractor de Docstrings es una herramienta en línea que extrae y analiza documentación de código fuente en JavaScript, TypeScript, Python y Java. Identifica comentarios JSDoc, docstrings de Python y JavaDoc, y genera un índice estructurado con metadatos como nombres de funciones, parámetros, valores de retorno y ejemplos.

Cuándo usarlo

  • •Cuando necesitas revisar rápidamente la documentación de un proyecto de código para entender su estructura.
  • •Para generar un índice de documentación que permita búsqueda y referencia rápida en bases de código grandes.
  • •Al analizar la completitud de la documentación en un código fuente, verificando que todas las funciones estén documentadas.

Cómo funciona

  • •Pega o introduce el código fuente en el área de texto 'Código Fuente'.
  • •Selecciona el lenguaje de programación en 'Lenguaje de Programación' o déjalo en 'Detección Automática' para identificarlo.
  • •La herramienta parsea los comentarios de documentación según el formato (JSDoc, Python docstrings, JavaDoc) y extrae metadatos.
  • •Genera un resultado JSON con nombres de símbolos, descripciones, parámetros, retornos, excepciones, ejemplos y números de línea.

Casos de uso

Auditoría de documentación en proyectos de software para asegurar que todas las funciones públicas tengan comentarios adecuados.
Generación automática de documentación para wikis internos o sistemas de referencia, extrayendo metadatos estructurados.
Análisis de código legacy para entender funcionalidades basadas en comentarios existentes, facilitando la modernización.

Ejemplos

1. Extraer JSDoc de un módulo JavaScript

Desarrollador Frontend
Contexto
Tienes un archivo JavaScript con funciones que usan comentarios JSDoc para documentar parámetros y retornos, pero necesitas un resumen rápido.
Problema
Revisar manualmente la documentación es lento y propenso a errores, especialmente en archivos grandes.
Cómo usarlo
Pega el código en el campo 'Código Fuente', selecciona 'JavaScript' en 'Lenguaje de Programación', y asegúrate de que 'Incluir Texto Completo de Documentación' esté marcado.
Configuración de ejemplo
languageHint: 'javascript', includeFullText: true
Resultado
Obtienes un JSON con una lista de funciones, sus descripciones, parámetros (nombres, tipos), valores de retorno y ejemplos, listo para integrar en herramientas de documentación.

2. Analizar docstrings en código Python

Contexto
Un proyecto Python con múltiples módulos que usan docstrings para documentar clases y métodos, pero falta un índice centralizado.
Problema
Necesitas verificar la completitud de la documentación y generar un informe para el equipo de desarrollo.
Cómo usarlo
Copia el código Python, pégalo en la herramienta, y deja 'Lenguaje de Programación' en 'Detección Automática' o selecciona 'Python' explícitamente.
Resultado
La herramienta extrae todos los docstrings, identifica parámetros en secciones 'Args', retornos en 'Returns' y excepciones en 'Raises', mostrando métricas como el porcentaje de funciones documentadas.

Probar con muestras

text
Ejemplos de Extractor de Enlaces Markdown
Documentos Markdown de muestra con varios tipos de enlaces para probar la herramienta de extracción de enlaces Markdown
title token extractor
text
Muestras de Extractor de Registro de Cambios
Varios formatos de registro de cambios para probar herramientas de análisis y extracción
title token extractor
text
Ejemplos de Extractor de Números de Teléfono
Colección de texto mixto que contiene números de teléfono de varios países para pruebas de extracción
title token extractor
text
Muestras de Documentación de Código
Ejemplos de código con varios estilos de documentación, incluyendo JSDoc, JavaDoc, docstrings de Python y anotaciones de TypeScript
matched family text
text

Hubs relacionados

Herramientas de Text para Convert
Explora 80 herramientas de text para flujos de convert y encuentra utilidades cercanas con rapidez.
Herramientas de Text
Explora 33 herramientas de text para flujos de utility y encuentra utilidades cercanas con rapidez.
Herramientas de Text para Analyze
Explora 12 herramientas de text para flujos de analyze y encuentra utilidades cercanas con rapidez.
Herramientas de Text para Format
Explora 9 herramientas de text para flujos de format y encuentra utilidades cercanas con rapidez.

Preguntas frecuentes

¿Qué lenguajes de programación soporta?

Soporta JavaScript, TypeScript, Python y Java, con detección automática o selección manual.

¿Qué información extrae de la documentación?

Extrae nombres de funciones/clases, descripciones, parámetros con tipos, valores de retorno, excepciones, ejemplos, números de línea y visibilidad.

¿Puedo incluir el texto completo de los comentarios?

Sí, mediante la opción 'Incluir Texto Completo de Documentación', que está activada por defecto para conservar los comentarios originales.

¿Cómo maneja diferentes formatos de documentación?

Analiza patrones comunes: JSDoc (`/** ... */`) para JavaScript/TypeScript, docstrings triples (`"""..."""`) para Python y JavaDoc (`/** ... */`) para Java.

¿El resultado incluye un índice de búsqueda?

Sí, genera un índice con nombres de símbolos categorizados por tipo (funciones, clases, métodos) y métricas de completitud.

Documentación de la API

Punto final de la solicitud

POST /es/api/tools/docstring-extractor

Parámetros de la solicitud

Nombre del parámetro Tipo Requerido Descripción
codeInput textarea Sí -
languageHint select No -
includeFullText checkbox No Incluir comentarios de documentación originales completos

Formato de respuesta

{
  "key": {...},
  "metadata": {
    "key": "value"
  },
  "error": "Error message (optional)",
  "message": "Notification message (optional)"
}
Datos JSON: Datos JSON

Documentación de MCP

Agregue este herramienta a su configuración de servidor MCP: 

{
  "mcpServers": {
    "elysiatools-docstring-extractor": {
      "name": "docstring-extractor",
      "description": "Extrae y analiza documentación de código fuente JavaScript/TypeScript, Python y Java",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=docstring-extractor",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

Puede encadenar múltiples herramientas, por ejemplo: `https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`, máximo 20 herramientas.

Si encuentra algún problema, por favor, póngase en contacto con nosotros en [email protected]