# Извлекатель Докстрингов Извлекает и анализирует документацию из исходного кода JavaScript/TypeScript, Python и Java > Каноническая страница: https://elysiatools.com/ru/tools/docstring-extractor - **Категория:** Development - **Ключевые слова:** документация, докстринг, jsdoc, javadoc, python, javascript, typescript, 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 ## Индекс Создает доступный для поиска индекс документации: - Имена символов для быстрого поиска - Категоризация по типу (функции, классы, методы) - Метрики полноты документации - Количество примеров, параметров и типов возврата ## Входные данные - **Исходный Код** (textarea): Вставьте ваш исходный код здесь для извлечения документации... - **Язык Программирования** (select) - **Включить Полный Текст Документации** (checkbox): Включить полные оригинальные комментарии документации ## Когда использовать - Когда необходимо быстро получить документацию из исходного кода без ручного копирования. - При анализе полноты и качества документации в проекте. - Для создания поискового индекса документации по кодовой базе. ## Как это работает - Вставьте исходный код в текстовое поле ввода. - Выберите язык программирования или используйте автоопределение. - Настройте опции, такие как включение полного текста документации. - Инструмент извлекает документацию и возвращает структурированные данные в формате JSON. ## Сценарии использования - Автоматическое извлечение документации для генерации API справочников. - Оценка покрытия документацией в существующих проектах. - Создание централизованного индекса документации для команды разработчиков. ## Частые вопросы ### Какие языки программирования поддерживаются? Инструмент поддерживает JavaScript, TypeScript, Python и Java. ### В каком формате предоставляется результат? Результат предоставляется в формате JSON с метаданными документации. ### Можно ли обрабатывать несколько файлов одновременно? Нет, инструмент обрабатывает один ввод кода за раз. ### Что делает опция 'Включить Полный Текст Документации'? Она включает оригинальные комментарии документации в вывод. ### Как инструмент определяет видимость членов класса? Инструмент анализирует код и извлекает информацию о публичных, приватных и защищенных членах. ## Связанные инструменты - [Извлекатель Журнала Изменений](https://elysiatools.com/ru/tools/changelog-extractor): Анализирует и извлекает структурированные данные из журналов изменений и примечаний к выпуску в различных форматах - [Парсер User Agent](https://elysiatools.com/ru/tools/new-user-agent-parser): Анализирует строки User Agent для извлечения информации о браузере, ОС, устройстве и движке - [Извлекатель Параметров URL](https://elysiatools.com/ru/tools/url-parameter-extractor): Извлечение и анализ параметров из URL включая строки запроса, фрагменты хэша и сегменты пути - [Парсер User-Agent](https://elysiatools.com/ru/tools/user-agent-parser): Анализирует строки User-Agent для извлечения информации о браузере, операционной системе, устройстве и движке - [Массовый Извлекатель Электронной Почты](https://elysiatools.com/ru/tools/bulk-email-extractor): Извлеките все адреса электронной почты из входного текста, статей, веб-исходного кода или смешанного содержимого. Поддерживает дедупликацию и экспорт в JSON. - [Извлекатель Дат](https://elysiatools.com/ru/tools/date-extractor): Извлекает даты из текста в различных форматах, включая китайский, ISO и американский с подробным анализом - [Деобфускатор JavaScript](https://elysiatools.com/ru/tools/javascript-deobfuscator): Деобфусцирует и анализирует запутанный код JavaScript для улучшения читаемости и понимания - [Извлекатель атрибутов HTML](https://elysiatools.com/ru/tools/html-attribute-extractor): Извлекает указанные атрибуты (href, src, data-*, и т.д.) из HTML-контента с поддержкой фильтрации по именам тегов ## Примеры - [Образцы Извлечения Журнала Изменений](https://elysiatools.com/ru/samples/changelog-extractor): Различные форматы журналов изменений для тестирования инструментов синтаксического анализа и извлечения - [Примеры Извлечения Ссылок Markdown](https://elysiatools.com/ru/samples/markdown-with-links): Примеры документов Markdown с различными типами ссылок для тестирования инструмента извлечения ссылок Markdown - [Примеры Извлечения Номеров Телефонов](https://elysiatools.com/ru/samples/phone-number-extractor): Коллекция смешанного текста, содержащего номера телефонов из различных стран для тестирования извлечения - [Примеры Обработки Изображений Web Python](https://elysiatools.com/ru/samples/web-image-processing-python): Примеры обработки изображений Web Python используя PIL/Pillow включая чтение, сохранение, изменение размера и преобразование формата ## Связанные материалы - [Инструменты для написания, извлечения и публикации документации](https://elysiatools.com/ru/hubs/documentation-authoring-publishing): Пишите документацию, извлекайте материалы из кода или PDF, проверяйте Markdown и экспортируйте аккуратные результаты в одном workflow-хабе. - [Инструменты конвертации регистра, кодировки и нормализации текста](https://elysiatools.com/ru/hubs/text-convert): Сравните в одном хабе конвертацию регистра, ширины символов, кодировок, работу с quoted-printable и встроенную нормализацию текста. - [Инструменты Text](https://elysiatools.com/ru/hubs/text-utility): Изучите 33 инструментов text для сценариев utility и быстро сравните близкие утилиты. - [Инструменты анализа текста, читаемости и проверки содержания](https://elysiatools.com/ru/hubs/text-analyze): Сравните в одном хабе текстовую статистику, определение языка, оценку читаемости, анализ тональности, модерацию и анализ шаблонов.