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