Как документировать обработчик событий в JSDoc?[закрыто]

Question

Предположим, у меня есть такой класс:

function myClass(q) {
  this.someFunction = function(e) {
      console.log("Click event");
  };

  jQuery(q).click(this.someFunction);
}

Есть ли способ указать JSDoc, что someFunction — это не просто функция, которую следует вызывать напрямую, а обработчик событий?

Я вижу тег @event, но, если я правильно понимаю, это больше для документирования функции в моем классе, которую я считаю событием (что-то, что клиентский код тоже зарегистрирует и что мой класс сработает при необходимости), а не обработчик событий функция?

Answer 1

Нет, документировать обработчик событий невозможно.

Поэтому лучший способ - задокументировать ее как обычную функцию, возможно, написав в ее описании жирным шрифтом или заглавными буквами, что это «ОБРАБОТЧИК СОБЫТИЙ».

Вы, наверное, уже это сделали, но на всякий случай:вы можете написать его жирным шрифтом, просто обернув текст в html-теги <strong></strong>.

Этот ответ устарел, но он не позволяет мне удалить его.

Answer 2

Ключевое слово @слушает

Пример использования:

/**
 * Outputs the event that happened
 *
 * @param {MyEvent} e - The observable event.
 * @listens MyEvent
 */
function myEventLogger(e) {
    console.log(e);
}

Следствием является @пожары ключевое слово для вызова события.