Extrator de Docstrings

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