javascript - 带有 JSDoc 的 jQuery 插件文档

Question

我想知道如何使用 JSDoc 记录 jQuery 插件？我的代码是:

   /**
     * The default configurations of comments
     * @typedef {Object} CommentConfig
     ...
     */

   /**
     * Show comments
     * @method comments
     * @version 1.0.1
     * @param {CommentConfig} options Configuration of comment
     */
    $.fn.comments = function (options) {
        // ..
    }

我想要 @method 是 $.fn.comments 但它不起作用。

Answer 1

根据 JSDoc3 docs你应该在你的情况下使用@external:

/**
 * The jQuery plugin namespace.
 * @external "jQuery.fn"
 * @see {@link http://docs.jquery.com/Plugins/Authoring The jQuery Plugin Guide}
 */

/**
 * Show comments
 * @function external:"jQuery.fn".comments
 */