Категории

← View All Tools

Извлекатель Докстрингов

Извлекает и анализирует документацию из исходного кода 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

Индекс

Создает доступный для поиска индекс документации:

  • Имена символов для быстрого поиска
  • Категоризация по типу (функции, классы, методы)
  • Метрики полноты документации
  • Количество примеров, параметров и типов возврата

Включить полные оригинальные комментарии документации

Ключевые факты

Категория
Development
Типы входных данных
textarea, select, checkbox
Тип результата
json
Покрытие примерами
4
API доступен
Yes

Обзор

Извлекатель Докстрингов — это инструмент для автоматического извлечения и анализа документации из исходного кода на JavaScript, TypeScript, Python и Java. Он поддерживает JSDoc, докстроки Python и JavaDoc, предоставляя структурированные метаданные для дальнейшего использования в разработке и документировании.

Когда использовать

  • •Когда необходимо быстро получить документацию из исходного кода без ручного копирования.
  • •При анализе полноты и качества документации в проекте.
  • •Для создания поискового индекса документации по кодовой базе.

Как это работает

  • •Вставьте исходный код в текстовое поле ввода.
  • •Выберите язык программирования или используйте автоопределение.
  • •Настройте опции, такие как включение полного текста документации.
  • •Инструмент извлекает документацию и возвращает структурированные данные в формате JSON.

Сценарии использования

Автоматическое извлечение документации для генерации API справочников.
Оценка покрытия документацией в существующих проектах.
Создание централизованного индекса документации для команды разработчиков.

Примеры

1. Извлечение JSDoc из JavaScript файла

Фронтенд разработчик
Контекст
Разработчик имеет файл с утилитами на JavaScript, содержащий JSDoc комментарии.
Проблема
Нужно быстро получить структурированную документацию для всех функций.
Как использовать
Вставьте код файла в поле 'Исходный Код', выберите язык 'JavaScript' и нажмите кнопку извлечения.
Пример конфигурации
{"languageHint": "javascript", "includeFullText": true}
Результат
Получен JSON с именами функций, описаниями, параметрами @param и возвращаемыми значениями @return.

2. Анализ докстроков Python модуля

Контекст
Python проект содержит модуль с классами и функциями, документированными с помощью докстроков.
Проблема
Требуется оценить, какие функции имеют полную документацию.
Как использовать
Загрузите код Python модуля, установите язык на 'Python' и включите опцию полного текста.
Результат
Инструмент извлекает докстроки с секциями Args, Returns, Raises, позволяя проанализировать полноту документации.

Проверить на примерах

text
Примеры Извлечения Ссылок Markdown
Примеры документов Markdown с различными типами ссылок для тестирования инструмента извлечения ссылок Markdown
title token extractor
text
Образцы Извлечения Журнала Изменений
Различные форматы журналов изменений для тестирования инструментов синтаксического анализа и извлечения
title token extractor
text
Примеры Извлечения Номеров Телефонов
Коллекция смешанного текста, содержащего номера телефонов из различных стран для тестирования извлечения
title token extractor
text
Образцы Документации Кода
Примеры кода с различными стилями документации, включая JSDoc, JavaDoc, docstrings Python и аннотации TypeScript
matched family text
text

Связанные хабы

Инструменты Text для Convert
Изучите 80 инструментов text для сценариев convert и быстро сравните близкие утилиты.
Инструменты Text
Изучите 33 инструментов text для сценариев utility и быстро сравните близкие утилиты.
Инструменты Text для Analyze
Изучите 12 инструментов text для сценариев analyze и быстро сравните близкие утилиты.
Инструменты Text для Format
Изучите 9 инструментов text для сценариев format и быстро сравните близкие утилиты.

FAQ

Какие языки программирования поддерживаются?

Инструмент поддерживает JavaScript, TypeScript, Python и Java.

В каком формате предоставляется результат?

Результат предоставляется в формате JSON с метаданными документации.

Можно ли обрабатывать несколько файлов одновременно?

Нет, инструмент обрабатывает один ввод кода за раз.

Что делает опция 'Включить Полный Текст Документации'?

Она включает оригинальные комментарии документации в вывод.

Как инструмент определяет видимость членов класса?

Инструмент анализирует код и извлекает информацию о публичных, приватных и защищенных членах.

Документация 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]