Новый с JSDoc. Лучший способ документировать обработчик событий в 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

Ключевое слово @listens

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

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

Следствие ведет @fires ключевое слово для поднятия события.