# Extractor de Docstrings Extrae y analiza documentación de código fuente JavaScript/TypeScript, Python y Java > Página canónica: https://elysiatools.com/es/tools/docstring-extractor - **Categoría:** Development - **Palabras clave:** documentación, docstring, jsdoc, javadoc, python, javascript, typescript, java, analizador, comentarios ## Descripción general ## 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 ## Entradas - **Código Fuente** (textarea): Pegue su código fuente aquí para extraer documentación... - **Lenguaje de Programación** (select) - **Incluir Texto Completo de Documentación** (checkbox): Incluir comentarios de documentación originales completos ## 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. ## 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. ## Herramientas relacionadas - [Extractor de Registro de Cambios](https://elysiatools.com/es/tools/changelog-extractor): Analiza y extrae datos estructurados de registros de cambios y notas de versión en múltiples formatos - [Analizador de User Agent](https://elysiatools.com/es/tools/new-user-agent-parser): Analiza cadenas de User Agent para extraer información del navegador, SO, dispositivo y motor - [Extractor de Parámetros URL](https://elysiatools.com/es/tools/url-parameter-extractor): Extraer y analizar parámetros de URLs incluyendo cadenas de consulta, fragmentos hash y segmentos de ruta - [Analizador User-Agent](https://elysiatools.com/es/tools/user-agent-parser): Analiza cadenas User-Agent para extraer información del navegador, sistema operativo, dispositivo y motor - [Extractor de Correo Electrónico Masivo](https://elysiatools.com/es/tools/bulk-email-extractor): Extrae todas las direcciones de correo electrónico de texto de entrada, artículos, código fuente web o contenido mixto. Soporta deduplicación y exportación a JSON. - [Extractor de Fechas](https://elysiatools.com/es/tools/date-extractor): Extrae fechas del texto en múltiples formatos incluyendo chino, ISO y formato estadounidense con análisis detallado - [Desofuscador JavaScript](https://elysiatools.com/es/tools/javascript-deobfuscator): Desofusca y analiza código JavaScript ofuscado para mejorar la legibilidad y comprensión - [Extractor de Atributos HTML](https://elysiatools.com/es/tools/html-attribute-extractor): Extrae atributos especificados (href, src, data-*, etc.) del contenido HTML con soporte de filtrado de nombres de etiquetas ## Ejemplos - [Muestras de Extractor de Registro de Cambios](https://elysiatools.com/es/samples/changelog-extractor): Varios formatos de registro de cambios para probar herramientas de análisis y extracción - [Ejemplos de Extractor de Enlaces Markdown](https://elysiatools.com/es/samples/markdown-with-links): Documentos Markdown de muestra con varios tipos de enlaces para probar la herramienta de extracción de enlaces Markdown - [Ejemplos de Extractor de Números de Teléfono](https://elysiatools.com/es/samples/phone-number-extractor): Colección de texto mixto que contiene números de teléfono de varios países para pruebas de extracción - [Ejemplos de Procesamiento de Imágenes Web Python](https://elysiatools.com/es/samples/web-image-processing-python): Ejemplos de procesamiento de imágenes Web Python usando PIL/Pillow incluyendo lectura, guardado, redimensionamiento y conversión de formato ## Contenido relacionado - [Herramientas para Redaccion, Extraccion y Publicacion de Documentacion](https://elysiatools.com/es/hubs/documentation-authoring-publishing): Redacta documentacion, extrae contenido desde codigo o PDF, revisa Markdown y exporta resultados pulidos en un solo hub de flujo documental. - [Herramientas de conversión de texto, codificación y normalización](https://elysiatools.com/es/hubs/text-convert): Compara conversión de mayúsculas y minúsculas, conversión de ancho de caracteres, conversión de codificación, manejo de quoted-printable y normalización de texto en un solo hub. - [Herramientas de Text](https://elysiatools.com/es/hubs/text-utility): Explora 33 herramientas de text para flujos de utility y encuentra utilidades cercanas con rapidez. - [Herramientas de análisis de texto, legibilidad e inspección de contenido](https://elysiatools.com/es/hubs/text-analyze): Compara estadísticas de texto, detección de idioma, legibilidad, análisis de sentimiento, revisión de moderación y análisis de patrones en un solo hub.