Cómo documentar un controlador de eventos en jsdoc? [cerrado]

Question

Supongamos que tengo una clase como esta:

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

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

¿Hay una manera de indicar a jsdoc que algunaFuncion no es sólo una función que debe ser invocado directamente sino más bien está un controlador de eventos?

ver la etiqueta @event pero si he entendido bien esto es más para documentar una función en mi clase que considero ser un evento (algo que el código de cliente registraría también y que mi clase se disparará cuando sea necesario) y no una función de controlador de eventos?

Answer 1

No, no hay manera de documentar un controlador de eventos.

Así que la mejor manera de hacerlo es documentarla como una función normal tal vez escribiendo en su descripción en texto en negrita o mayúsculas que es un "gestor de eventos".

Es probable que ya ahora esto, pero por si acaso: se puede escribir en negrita simplemente envolviendo el texto en html etiquetas <strong></strong>

.

Esta respuesta se considera obsoleto, pero no me deja borrarlo.

Answer 2

La palabra clave es @listens

Ejemplo de uso:

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

El corolario es la @fires palabra clave para elevar el evento.