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

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

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

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

А так объект деструктурируется, что позволяет вызывать функцию с именованными параметрами. Как это описать в JSDoc? Или это взаимоисключающие вещи?
  • Вопрос задан
  • 303 просмотра
Подписаться 1 Простой Комментировать
Помогут разобраться в теме Все курсы
  • Яндекс Практикум
    Фронтенд-разработчик
    10 месяцев
    Далее
  • Skillfactory
    Профессия Веб-разработчик
    12 месяцев
    Далее
  • Яндекс Практикум
    Мидл фронтенд-разработчик
    5 месяцев
    Далее
  • Stepik
    JavaScript с нуля - основы языка и практика для начинающих
    2 недели
    Далее
  • Merion Academy
    Фронтенд-разработчик с нуля
    4 месяца
    Далее
  • Skypro
    JavaScript-разработчик с нуля
    9 месяцев
    Далее
  • Нетология
    Fullstack-разработчик на Python + нейросети
    20 месяцев
    Далее
  • Skillbox
    JavaScript
    3 месяца
    Далее
Решения вопроса 1
yarkov
@yarkov Куратор тега JavaScript
Помог ответ? Отметь решением.
https://jsdoc.app/tags-param.html
Секция Documenting a destructuring parameter
Ответ написан
Пригласить эксперта
Ваш ответ на вопрос

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

Похожие вопросы