Como documentar um manipulador de eventos no JSDOC? [fechado

Question

Suponha que eu tenha uma aula como esta:

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

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

Existe uma maneira de indicar ao JSDOC que alguma função não é apenas uma função que deve ser invocada diretamente, mas é um manipulador de eventos?

Eu vejo a tag @Event, mas se eu entender corretamente, isso é mais para documentar uma função na minha classe que considero um evento (algo que o código do cliente também se registraria e que minha classe disparará quando necessário) e não um manipulador de eventos função?

Answer 1

Não, não há como documentar um manipulador de eventos.

Portanto, a melhor maneira é documentá -lo como uma função normal, talvez escrevendo em sua descrição em texto em negrito ou maiúsculas que é um "manipulador de eventos".

Você provavelmente já agora é isso, mas apenas por precaução: você pode escrever em negrito simplesmente envolvendo o texto em tags html <strong></strong>.

Esta resposta está agora presa, mas não me permite excluí -la.

Answer 2

A palavra -chave é @listens

Exemplo de uso:

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

O corolário é o @incêndios Palavra -chave para aumentar o evento.