Возможности
Извлекает документацию из нескольких языков программирования:
- 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
Индекс
Создает доступный для поиска индекс документации:
- Имена символов для быстрого поиска
- Категоризация по типу (функции, классы, методы)
- Метрики полноты документации
- Количество примеров, параметров и типов возврата