eine Javascript-Funktion Da die Callback-Funktionen als Parameter verwendet:Wie dokumentieren Rückrufe mit JSDoc?
var myFunction = function(onSuccess, onFailure) {...}
Wie dokumentiere ich onSuccess ‚s Rückgabetyp und Argumente?
In JSDoc 3.1 und höher können Sie die neue @callback-Tag verwenden, um die Callback-Funktion in einem separaten Kommentarblock zu beschreiben. Sie können dann auf den Rückruf in den Dokumenten für Ihre Methode verweisen.
Hier ist ein Beispiel:
/** @class */
function MyClass() {}
/**
* Do something.
* @param {MyClass~onSuccess} cb - Called on success.
*/
MyClass.prototype.myFunction = function(cb) {
// code
};
/**
* Callback used by myFunction.
* @callback MyClass~onSuccess
* @param {number} resultCode
* @param {string} resultMessage
*/
Siehe Use JSDoc für weitere Informationen.
Es scheint, dass diese Funktionalität noch nicht existiert.
Diese Funktionalität wurde ab JSDoc 3.1 hinzugefügt. Siehe:
für eine ähnliche Diskussion.