На главную
Конвертеры и генераторы кода
Генератор JSDoc
По сигнатуре функции строит комментарий с @param, @returns и типами.
Комментарий
/**
* fetchUser: опишите, что делает функция.
*
* @param {string} id — описание.
* @param {number} [retries=3] — описание.
* @async
* @returns {Promise<User>} — что возвращает.
*/Вместе с сигнатурой
/**
* fetchUser: опишите, что делает функция.
*
* @param {string} id — описание.
* @param {number} [retries=3] — описание.
* @async
* @returns {Promise<User>} — что возвращает.
*/
export async function fetchUser(id: string, retries = 3): Promise<User> {
// …
}Что распознано
ИмяfetchUser
Асинхроннаяда
ВозвращаетPromise<User>
| Параметр | Тип | Необязательный | По умолчанию |
|---|---|---|---|
| id | string | нет | — |
| retries | number | да | 3 |
Откуда берутся типы
- Есть аннотация TypeScript — берётся она.
- Есть значение по умолчанию — тип выводится из него (3 → number, «текст» → string).
- Иначе тип угадывается по имени: isReady → boolean, count → number, onClick → Function.
- Деструктуризация сворачивается в один параметр options с перечислением полей.