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

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

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

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


jsdoc
person Gili    schedule 15.11.2012    source источник

Ответы (2)


arrow_upward
27
arrow_downward

В 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.

person Jeff Williams    schedule 04.04.2013

arrow_upward
2
arrow_downward

Похоже, такой функции еще не существует.

Эта функциональность была добавлена ​​в JSDoc 3.1. Видеть:

для соответствующего обсуждения.

person Gili    schedule 06.12.2012