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
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]