# Extrator de Docstrings Extrai e analisa documentação de código fonte JavaScript/TypeScript, Python e Java > Página canônica: https://elysiatools.com/pt/tools/docstring-extractor - **Categoria:** Development - **Palavras-chave:** documentação, docstring, jsdoc, javadoc, python, javascript, typescript, java, parser, comentários ## Visão geral ## Recursos Extrai documentação de várias linguagens de programação: - **JSDoc**: Comentários de documentação JavaScript e TypeScript - **Docstrings Python**: Documentação de funções e classes em aspas triplas - **JavaDoc**: Comentários de documentação Java com tags padrão ## Extração Extrai metadados completos de documentação: - **Nomes de funções/classes**: Identificadores de símbolos - **Descrições**: Texto principal da documentação - **Parâmetros**: Tags @param com nomes, tipos e descrições - **Valores de retorno**: Tags @return ou @returns - **Exceções**: Tags @throws, @exception ou seções raises - **Exemplos**: Tags @example ou blocos de código de exemplo - **Números de linha**: Localização no código fonte - **Visibilidade**: Membros públicos, privados ou protegidos ## Análise Analisa padrões comuns de documentação: - JSDoc: `/** ... */` com @param, @return, @throws - Python: `"""..."""` com seções Args, Returns, Raises - JavaDoc: `/** ... */` com @param, @return, @throws ## Índice Gera um índice de documentação pesquisável: - Nomes de símbolos para pesquisa rápida - Categorização por tipo (funções, classes, métodos) - Métricas de completude da documentação - Contagem de exemplos, parâmetros e tipos de retorno ## Entradas - **Código Fonte** (textarea): Cole seu código fonte aqui para extrair documentação... - **Linguagem de Programação** (select) - **Incluir Texto Completo da Documentação** (checkbox): Incluir comentários de documentação originais completos ## Quando usar - Ao gerar documentação técnica automática a partir de comentários no código. - Ao auditar a qualidade e a completude da documentação em grandes bases de código. - Ao migrar ou refatorar projetos e precisar mapear rapidamente todas as funções e classes documentadas. ## Como funciona - Cole o seu código-fonte na área de entrada ou selecione a linguagem específica para uma análise mais precisa. - O sistema identifica automaticamente os padrões de comentários (JSDoc, Docstrings ou JavaDoc) presentes no arquivo. - A ferramenta processa os metadados, incluindo parâmetros, tipos de retorno, exceções e exemplos, gerando um JSON estruturado. - Visualize o índice gerado com métricas de completude e detalhes de cada símbolo encontrado no código. ## Casos de uso - Criação automática de portais de documentação interna para equipes de engenharia. - Verificação de conformidade de documentação em processos de revisão de código (Code Review). - Extração de metadados para alimentar ferramentas de busca de APIs ou bibliotecas internas. ## Perguntas frequentes ### Quais linguagens são suportadas? A ferramenta suporta nativamente JavaScript, TypeScript, Python e Java. ### Como a ferramenta lida com diferentes estilos de documentação? Ela reconhece padrões específicos como JSDoc para JS/TS, Docstrings de aspas triplas para Python e JavaDoc para Java. ### É possível extrair apenas os metadados sem o texto completo? Sim, você pode desmarcar a opção 'Incluir Texto Completo da Documentação' para obter apenas os metadados estruturados. ### O que é o índice de documentação? É um resumo pesquisável que categoriza funções e classes, fornecendo métricas sobre quantos parâmetros e exemplos foram documentados. ### A ferramenta altera o meu código original? Não, o Extrator de Docstrings apenas lê e analisa o código fornecido, sem realizar qualquer modificação ou escrita nos arquivos. ## Ferramentas relacionadas - [Extrator de Registro de Alterações](https://elysiatools.com/pt/tools/changelog-extractor): Analisa e extrai dados estruturados de registros de alterações e notas de versão em vários formatos - [Analisador de User Agent](https://elysiatools.com/pt/tools/new-user-agent-parser): Analisa strings de User Agent para extrair informações de navegador, SO, dispositivo e mecanismo - [Extrator de Parâmetros URL](https://elysiatools.com/pt/tools/url-parameter-extractor): Extrair e analisar parâmetros de URLs incluindo strings de consulta, fragmentos hash e segmentos de caminho - [Analisador User-Agent](https://elysiatools.com/pt/tools/user-agent-parser): Analisa strings User-Agent para extrair informações do navegador, sistema operacional, dispositivo e motor - [Extrator de Emails em Massa](https://elysiatools.com/pt/tools/bulk-email-extractor): Extraia todos os endereços de e-mail de texto de entrada, artigos, código-fonte da web ou conteúdo misto. Suporta desduplicação e exportação para JSON. - [Extrator de Datas](https://elysiatools.com/pt/tools/date-extractor): Extrai datas do texto em vários formatos incluindo chinês, ISO e formato dos EUA com análise detalhada - [Desofuscador JavaScript](https://elysiatools.com/pt/tools/javascript-deobfuscator): Desofusca e analisa código JavaScript ofuscado para melhorar legibilidade e compreensão - [Extrator de Atributos HTML](https://elysiatools.com/pt/tools/html-attribute-extractor): Extrai atributos especificados (href, src, data-*, etc.) do conteúdo HTML com suporte para filtragem de nomes de tags ## Exemplos - [Amostras de Extrator de Log de Alterações](https://elysiatools.com/pt/samples/changelog-extractor): Vários formatos de log de alterações para testar ferramentas de análise e extração - [Exemplos de Extrator de Links Markdown](https://elysiatools.com/pt/samples/markdown-with-links): Documentos Markdown de amostra com vários tipos de links para testar a ferramenta de extração de links Markdown - [Exemplos de Extrator de Números de Telefone](https://elysiatools.com/pt/samples/phone-number-extractor): Coleção de texto misto contendo números de telefone de vários países para testes de extração - [Exemplos de Processamento de Imagem Web Python](https://elysiatools.com/pt/samples/web-image-processing-python): Exemplos de processamento de imagem Web Python usando PIL/Pillow incluindo leitura, salvamento, redimensionamento e conversão de formato ## Conteúdo relacionado - [Ferramentas de Redacao, Extracao e Publicacao de Documentacao](https://elysiatools.com/pt/hubs/documentation-authoring-publishing): Escreva documentacao, extraia conteudo de codigo ou PDFs, revise Markdown e exporte resultados polidos em um unico hub de fluxo documental. - [Ferramentas de conversão de caixa, codificação e normalização de texto](https://elysiatools.com/pt/hubs/text-convert): Compare conversão de caixa de texto, conversão de largura de caracteres, conversão de codificação, tratamento de quoted-printable e normalização de texto em um único hub. - [Ferramentas de Text](https://elysiatools.com/pt/hubs/text-utility): Explore 33 ferramentas de text para fluxos de utility e encontre utilitários próximos com rapidez. - [Ferramentas de análise de texto, legibilidade e inspeção de conteúdo](https://elysiatools.com/pt/hubs/text-analyze): Compare estatísticas de texto, detecção de idioma, legibilidade, análise de sentimento, revisão de moderação e análise de padrões em um único hub.