Ich versuche meine Funktionen mit der JSDoc-Syntax zu dokumentieren.
%Vor% Die obige Funktion akzeptiert ein einzelnes Argument, das entweder ein JQuery-Objekt oder ein von document.getElementById zurückgegebenes Element sein kann.
Was ist der gültige JSDoc-Typ für den Rückgabewert von getElementById ?
Zum Beispiel sind beide gültig:
%Vor%Wo finde ich das auch in Zukunft heraus?
In Ihrem Szenario scheint Element am geeignetesten zu sein, aber im Allgemeinen möchten Sie so genau sein, wie es Ihr Code zulässt.
Wenn Sie zum Beispiel neuere erweiterte IDEs verwenden, wird mit Element keine automatische Vervollständigung für Attribute wie disabled oder readOnly bereitgestellt. Ich finde es nützlich, zum Beispiel den HTMLInputElement @type zu verwenden.
getElementById() gibt auch ein JavaScript-Objekt zurück.
in jQuery - & gt; $ ('# input') umschließt das Element einfach mit einer ID der Eingabe in ein jQuery-Objekt, so dass jQuery-Methoden darauf angewendet werden können.
In beiden Fällen ist der Typ also ein Objekt.
%Vor%Tags und Links javascript jsdoc