Question

我想创建足够的文档并为返回Deferred对象的函数启用提示。使用JSDoc记录Deferred.done回调的正确方法（如果有的话）是什么？到目前为止，我有：

/**
 * Creates component element.
 * @param {Object} settings
 * @returns {Deferred}
 */
$.fn.customDialogue.createElement = function (settings) {
    var deferred = $.fn.dialogue.createElement(settings);
    $.when(…).done(function (dialogueElement) {
        deferred.resolve(dialogueElement.customDialogue(settings));
    });
    return deferred;
};

我想在文档中指出返回的Deferred done()回调接受@param {jQuery} element，例如：

$deferred.done(function(element){
    …
});

编辑：

我正在使用PhpStorm，它并不完全支持JSDoc，但以下似乎可行。如果你知道一个，可以发布一个更好的解决方案。

/**                                                                                              
 * @function                                                                                     
 * @name Deferred.done                                                                           
 * @param {function(element:jQuery)} callback                                                    
 */                                                                                              

/**                                                                                              
 * Creates new component element and returns a deferred object.                                  
 * @param {Object} settings                                                                      
 * @returns {Deferred}                                                                           
 */                                                                                              
$.fn.customDialogue.createElement = function (settings) {
    var deferred = $.fn.dialogue.createElement(settings);
    $.when(…).done(function (dialogueElement) {
        deferred.resolve(dialogueElement.customDialogue(settings));
    });
    return deferred;
};

看起来像这样：http://d.pr/i/j506

JSDoc for jQuery Deferred.done回调

编辑：

0 个答案: