Wie ein Event-Handler in JSDoc dokumentieren? [geschlossen]

Question

Angenommen, ich habe eine Klasse wie folgt aus:

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

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

Gibt es eine Möglichkeit zu JSDoc um anzuzeigen, dass somefunction ist nicht nur eine Funktion, die direkt aufgerufen werden sollen, sondern wird ein Event-Handler?

Ich sehe den @Event Tag, aber wenn ich das richtig verstanden, das ist mehr eine Funktion in meiner Klasse zu dokumentieren, dass halte ich für ein Ereignis sein (was der Client-Code registrieren würde und dass meine Klasse wird ausgelöst, wenn erforderlich) und nicht eine Event-Handler-Funktion?

Answer 1

Nein, es gibt keine Möglichkeit, einen Event-Handler zu dokumentieren.

So ist die beste Art und Weise ist es wie eine normale Funktion zu dokumentieren, vielleicht in seiner Beschreibung in Fettschrift oder Großbuchstaben zu schreiben, die ein „Event-Handler“ ist.

Sie haben wahrscheinlich schon jetzt das, aber nur für den Fall: Sie können es in fett schreiben, indem einfach das Einwickeln der Text in HTML-Tags <strong></strong>

.

Diese Antwort jetzt veraltet ist, aber es hat mich nicht zulassen, löschen.

Answer 2

Das Schlüsselwort wird @listens

Anwendungsbeispiel:

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

Die logische Folge ist das @fires Stichwort für das das Ereignis auslöst.