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

Acording到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 
*/