Как записывать функции, которые имеют несколько параметров порядка параметров в JsDoc?

Question

У меня есть функция для удаления обработчиков событий из класса EventEmitter. Это выглядит примерно так:

EventEmitter.prototype.remove_handler = function(event_name, handler) { 
    if(arguments.length < 2) { 
     handler = event_name; 
     event_name = null; 
    } 

    // ... 
}; 

Функция может либо вызываться с именем события и обработчика, или просто обработчиком. Если имя события присутствует, обработчик удаляется из этого конкретного события, в противном случае он полностью удаляется из эмитента события.

Как документировать такие сценарии в JsDoc? В этом случае я мог бы просто документировать параметры по мере их появления и отметить, что «event_name может быть опущено, в любом случае (и т. Д.)», Но я, конечно же, могу представить себе сценарии, где это было бы невозможно.

Answer 1

Вы можете использовать @also тег для обеспечения нескольких сигнатур методов:

/** 
* 
* @param {String} event_name 
* @param {Function} handler 
* 
* @also 
* 
* @param {Function} handler 
*/ 
EventEmitter.prototype.remove_handler = function(event_name, handler) {