使用 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

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

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

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

/** @class JSON */

通过“解决问题”，我的意思是我生成的文档中有一个页面专门用于 JSON 对象，它包含copy()和equals()成员所需的文档，我可以链接到我文档中其他地方的那些成员。

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