Подтвердить что ты не робот

Как документировать обратные вызовы с помощью JSDoc?

Учитывая функцию Javascript, которая выполняет функции обратного вызова в качестве параметров:

var myFunction = function(onSuccess, onFailure) {...}

Как я могу документировать onSuccess тип возвращаемого значения и аргументы?

4b9b3361

ОТВЕТЫ

Ответ 1

В JSDoc 3.1 и более поздних версиях вы можете использовать новый тег @callback для описания функции обратного вызова в отдельном блоке комментариев. Затем вы можете обратиться к обратному вызову в документах для своего метода.

Вот пример:

/** @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
 */

Подробнее см. Использовать JSDoc.