ProgrammerForever
@ProgrammerForever
Учитель, автоэлектрик, программист, музыкант

Как правильно оформить JSDoc?

Добрый день. Подскажите, как правильно оформить JSDoc комментарий для такой ситуации: есть функция, которая принимает на вход объект
function sum({n1,n2=100}={}){
  return +n1+n2;
};

Если бы был просто список параметров, тогда:
/**
 * Суммирует числа
 *
 * @param {number} n1 - Первое слагаемое
 * @param {number} [n2=100] - Второе слагаемое
 * @return	{number} Сумма чисел
 */

А так объект деструктурируется, что позволяет вызывать функцию с именованными параметрами. Как это описать в JSDoc? Или это взаимоисключающие вещи?
  • Вопрос задан
  • 65 просмотров
Решения вопроса 1
yarkov
@yarkov Куратор тега JavaScript
Проект "Жизнь после смерти" - lifeafterdeath.ru
https://jsdoc.app/tags-param.html
Секция Documenting a destructuring parameter
Ответ написан
Пригласить эксперта
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы