Задать вопрос

JSDoc. Как объявить разные типы аргументов для одной функции?

Здравствуйте.
Как сказать парсеру о том, что метод принимает совершенно разные аргументы, например:
строка, строка, строка, строка
строка, строка, объект
объект, строка, строка
объект, объект
массив

Объявлять только лишь один набор аргументов нет смысла, так как метод, хотя и делает одно и то же, но принимает разные аргументы совершенно равносильно, приводя их в начале к общему виду (например, к массиву).
  • Вопрос задан
  • 3057 просмотров
Подписаться 3 Оценить Комментировать
Решения вопроса 1
Finom
@Finom Автор вопроса
Отвечаю сам. Нужно смотреть тег @variation. Он добавляет методы с одинаковыми именами в документацию. Для того, чтоб избежать дублирования заголовка, надо ковырять шаблон, чем и займусь на досуге (судя по логике шаблона, это не так и сложно).
Ответ написан
Комментировать
Пригласить эксперта
Ответы на вопрос 2
@Sayonji
Вот тут показывается два решения. Второе вроде бы приятное:
/**
    @name init
    @function
    @param {string} key
    @param {mixed} value
 */
 /**
    @name init^2
    @function
    @param {object} keyValues
 */
var init = function() {
 ...
Но я не проверял.
Ответ написан
Anonym
@Anonym
Программирую немного )
/**
  @param {String|Object|Array} v1
  @param {String|Object} [v2]
  @param {String} [v3]
  @param {String} [v4]
 */

Но, мне кажется, вам нужно не это.
Ответ написан
Ваш ответ на вопрос

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

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