javascript - 如何在 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) {