Cho một hàm Javascript mà có chức năng gọi lại như thông số:Làm cách nào để ghi lại các cuộc gọi lại bằng JSDoc?
var myFunction = function(onSuccess, onFailure) {...}
Làm thế nào để ghi lại onSuccess 's kiểu trả về và lập luận?
Trong JSDoc 3.1 trở lên, bạn có thể sử dụng thẻ @callback mới để mô tả chức năng gọi lại trong một khối nhận xét riêng biệt. Sau đó, bạn có thể tham khảo cuộc gọi lại trong tài liệu cho phương thức của mình.
Dưới đây là một ví dụ:
/** @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
*/
Xem Use JSDoc để biết thêm thông tin.
Dường như chức năng này chưa tồn tại.
Chức năng này đã được thêm vào như JSDoc 3.1. Xem:
cho một cuộc thảo luận liên quan.