使用JSDoc记录原型扩展函数

Question

我有以下代码：

/** @module Array */

/**
 * Returns this model's attributes as...
 *
 * @memberof Array.prototype
 * @function
 * @name each
**/
Array.prototype.each = function( callback ) {

    var context = this;

    for( var i = 0; i < context.length; i++ ) {
        callback( context[ i ] );
    }

}

当我用JSDoc记录这个时，我得到：

为什么呢？我在Gulp上使用JSDoc。

Answer 1

我遇到了与原始海报相同的问题，但我使用 JSON 和 copy() 方法扩展了 equals() 全局。

（由于上面的评论中有一些争论，我将澄清：当我说“有同样的问题”时，我的意思是我放在 JSON.copy() 和 JSON.equals() 方法之前的 JSDoc 评论没有出现在我生成的文档中的任何地方，这是一个问题，不仅因为该文档丢失了，还因为没有其他文档可以链接到 JSON.copy() 或 JSON.equals() 方法。）

按照 FreeLightman 在上面评论中的建议，只需添加以下行，即可为我解决问题。

/** @class JSON */

“解决问题”是指在我生成的文档中现在有一个专门针对 JSON 对象的页面，其中包含 copy() 和 equals() 所需的文档成员，我可以从我的文档中的其他地方链接到这些成员。

由于这是在原始问题之后多年，我将指出我使用的是 JSDoc 版本 6.14.12。