Извлекатель Докстрингов
Извлекает и анализирует документацию из исходного кода JavaScript/TypeScript, Python и Java
## Возможности
Извлекает документацию из нескольких языков программирования:
- **JSDoc**: Комментарии документации JavaScript и TypeScript
- **Докстроки Python**: Документация функций и классов в тройных кавычках
- **JavaDoc**: Комментарии документации Java со стандартными тегами
## Извлечение
Извлекает полные метаданные документации:
- **Имена функций/классов**: Идентификаторы символов
- **Описание**: Основной текст документации
- **Параметры**: Теги @param с именами, типами и описаниями
- **Возвращаемые значения**: Теги @return или @returns
- **Исключения**: Теги @throws, @exception или секции raises
- **Примеры**: Теги @example или блоки примера кода
- **Номера строк**: Расположение в исходном коде
- **Видимость**: Публичные, приватные или защищенные члены
## Анализ
Анализирует общие паттерны документации:
- JSDoc: `/** ... */` с @param, @return, @throws
- Python: `"""..."""` с секциями Args, Returns, Raises
- JavaDoc: `/** ... */` с @param, @return, @throws
## Индекс
Создает доступный для поиска индекс документации:
- Имена символов для быстрого поиска
- Категоризация по типу (функции, классы, методы)
- Метрики полноты документации
- Количество примеров, параметров и типов возврата
Документация API
Конечная точка запроса
POST /ru/api/tools/docstring-extractor
Параметры запроса
| Имя параметра | Тип | Обязательно | Описание |
|---|---|---|---|
| codeInput | textarea | Да | - |
| languageHint | select | Нет | - |
| includeFullText | checkbox | Нет | Включить полные оригинальные комментарии документации |
Формат ответа
{
"key": {...},
"metadata": {
"key": "value"
},
"error": "Error message (optional)",
"message": "Notification message (optional)"
}
Данные JSON:
Данные JSON
Документация MCP
Добавьте этот инструмент к конфигурации сервера MCP:
{
"mcpServers": {
"elysiatools-docstring-extractor": {
"name": "docstring-extractor",
"description": "Извлекает и анализирует документацию из исходного кода JavaScript/TypeScript, Python и Java",
"baseUrl": "https://elysiatools.com/mcp/sse?toolId=docstring-extractor",
"command": "",
"args": [],
"env": {},
"isActive": true,
"type": "sse"
}
}
}
Вы можете объединять несколько инструментов, например: `https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`, максимум 20 инструментов.
Если вы столкнулись с проблемами, пожалуйста, свяжитесь с нами по адресу [email protected]