Categorias

← View All Tools

Extrator de Docstrings

Extrai e analisa documentação de código fonte JavaScript/TypeScript, Python e Java

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

Incluir comentários de documentação originais completos

Fatos principais

Categoria
Development
Tipos de entrada
textarea, select, checkbox
Tipo de saída
json
Cobertura de amostras
4
API disponível
Yes

Visão geral

O Extrator de Docstrings é uma ferramenta essencial para desenvolvedores que precisam automatizar a análise e extração de documentação técnica diretamente de arquivos de código-fonte em JavaScript, TypeScript, Python e Java.

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.

Exemplos

1. Extração de Documentação em Python

Desenvolvedor Backend
Contexto
Um desenvolvedor precisa documentar uma API complexa escrita em Python e quer garantir que todos os parâmetros e exceções estejam mapeados.
Problema
Manter a documentação sincronizada com o código manualmente é propenso a erros e esquecimentos.
Como usar
Cole o código Python com Docstrings no campo de entrada e selecione 'Python' no seletor de linguagem.
Resultado
O sistema retorna um JSON contendo todos os argumentos, retornos e exceções (raises) extraídos, permitindo a geração automática de um arquivo README ou Swagger.

2. Auditoria de JSDoc em Projeto Frontend

Tech Lead
Contexto
O Tech Lead precisa avaliar se a equipe está seguindo o padrão de documentação JSDoc em um projeto grande em TypeScript.
Problema
Identificar quais funções estão sem descrição ou sem definição de tipos de retorno.
Como usar
Insira o código TypeScript e utilize o índice gerado para verificar a contagem de parâmetros e tipos de retorno por função.
Resultado
Um relatório estruturado que destaca quais funções possuem documentação incompleta, facilitando a atribuição de tarefas de melhoria de código.

Testar com amostras

text
Exemplos de Extrator de Links Markdown
Documentos Markdown de amostra com vários tipos de links para testar a ferramenta de extração de links Markdown
title token extractor
text
Amostras de Extrator de Log de Alterações
Vários formatos de log de alterações para testar ferramentas de análise e extração
title token extractor
text
Exemplos de Extrator de Números de Telefone
Coleção de texto misto contendo números de telefone de vários países para testes de extração
title token extractor
text
Amostras de Documentação de Código
Exemplos de código com vários estilos de documentação, incluindo JSDoc, JavaDoc, docstrings Python e anotações TypeScript
matched family text
text

Hubs relacionados

Ferramentas de Text para Convert
Explore 80 ferramentas de text para fluxos de convert e encontre utilitários próximos com rapidez.
Ferramentas de Text
Explore 33 ferramentas de text para fluxos de utility e encontre utilitários próximos com rapidez.
Ferramentas de Text para Analyze
Explore 12 ferramentas de text para fluxos de analyze e encontre utilitários próximos com rapidez.
Ferramentas de Text para Format
Explore 9 ferramentas de text para fluxos de format e encontre utilitários próximos com rapidez.

FAQ

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.

Documentação da API

Ponto final da solicitação

POST /pt/api/tools/docstring-extractor

Parâmetros da solicitação

Nome do parâmetro Tipo Requerido Descrição
codeInput textarea Sim -
languageHint select Não -
includeFullText checkbox Não Incluir comentários de documentação originais completos

Formato de resposta

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

Documentação de MCP

Adicione este ferramenta à sua configuração de servidor MCP: 

{
  "mcpServers": {
    "elysiatools-docstring-extractor": {
      "name": "docstring-extractor",
      "description": "Extrai e analisa documentação de código fonte JavaScript/TypeScript, Python e Java",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=docstring-extractor",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

Você pode encadear várias ferramentas, ex: `https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`, máx 20 ferramentas.

Se você encontrar algum problema, por favor, entre em contato conosco em [email protected]