JSDoc Generator

Расширение для Visual Studio Code, автоматически генерирующее JSDoc-комментарии к функциям на основе их сигнатуры.

Автор

Браев Денис Германович Группа: М3101

Что делает расширение

По команде из палитры расширение:

1. Находит функцию под курсором (поиск вверх по документу).
2. Разбирает её сигнатуру: имя, параметры, возвращаемый тип.
3. Формирует описание функции из её имени (разбор camelCase и словари).
4. Вставляет готовый JSDoc-блок над функцией.

Поддерживаются четыре формы объявления функций:

• обычная функция function name(...) { };
• стрелочная функция const name = (...) => { };
• функциональное выражение const name = function(...) { };
• метод класса name(...) { }.

Пример работы

Было:

function calculatePrice(base: number, discount: number): number {
    return base * (1 - discount);
}

Стало:

/**
 * Вычисляет цену.
 *
 * @param {number} base
 * @param {number} discount
 * @returns {number}
 */
function calculatePrice(base: number, discount: number): number {
    return base * (1 - discount);
}

Как пользоваться

1. Откройте файл .ts, .js, .tsx или .jsx.
2. Поставьте курсор на строку с функцией.
3. Нажмите Ctrl+Shift+P.
4. Введите JSDoc и выберите команду «JSDoc Generator: JSDoc: сгенерировать комментарий».

Что учитывается

• TypeScript: типы параметров подставляются в @param {тип}.
• JavaScript: типы не подставляются, только имена параметров.
• Опциональные параметры (name?: string) — маркер ? отбрасывается.
• Параметры со значением по умолчанию (count: number = 0) — значение отбрасывается.
• Функции без параметров и без возврата — короткая заглушка /** */.
• Функции, возвращающие void — тег @returns не добавляется.

Ограничения

• Деструктурированные параметры ({ a, b }) считаются одним параметром.
• Сложные generic-типы переносятся строкой без разбора.
• Перегруженные функции не поддерживаются.
• Незнакомые слова в именах функций остаются без перевода — словари VERBS и NOUNS легко расширяются.

Требования

• Visual Studio Code версии 1.80 или выше.
• Node.js для сборки проекта.

Установка и сборка

git clone <адрес-репозитория>
cd jsdoc-generator
npm install
npm run compile

Запуск в режиме разработки

1. Откройте проект в VS Code.
2. Нажмите F5 — откроется новое окно с уже загруженным расширением.
3. В этом новом окне откройте любой .ts-файл и вызовите команду.

Документация

Подробное описание архитектуры и логики работы — в файле docs/architecture.md.

Лицензия

MIT