JSDoc：在另一个@param中引用方法的@param

Question

我是使用JSDocs的新手，无法找到这个问题的答案。

假设我想写这个简单的函数：

function hasQ(array, item) {return array.includes(item);}

使用JSDoc，我会标记为：

/**
* Another way to call array.includes(item);
* @param {Array} array
* @param {*} item to test if contained in array
* @returns
*/

我有没有办法在第二个array语句中标记@param这个词，以便它引用第一个@param？

这只是一个玩具示例，但我希望它能够明确这个概念。

Answer 1

参考外部

在@link中有一个将external内联到JSDoc资源的概念，我想在这里很有用。您可以在说明中明确指出，例如您在谈论includes的函数Array：

/**
* Another way to call [Array's includes function]{@link external:Array#includes}
* @param {Array} array
* @param {*} item to test if contained in array
* @returns
*/
function hasQ(array, item) {
    return array.includes(item);
}

或者，如果您更喜欢没有text的链接，只需在第一行中删除[]内的部分：

/**
* Another way to call {@link external:Array#includes}

参考参数

• 据我所知，关于@param， 交叉参考参数。如建议 here可以使用普通格式 英语。

• 还有另一种方式，我注意到here使用``降价突出显示param的名称。

更多

如果您有兴趣阅读更多内容：

• @external tag
• inline @link tag
• @see tag

Answer 2

没有办法做到。来源：https://github.com/jsdoc/jsdoc/issues/1145

Answer 3

我没有看到编写相关参数的可能性（但请参阅parameters with properties）。但你可以写描述;）

/**
 * @method
 * @param {Array} array - description for this param
 * @param {*} item - description for this param
 * @description Please write your description for Method
 * @returns {*|boolean}
 */
const hasQ = (array, item) => array.includes(item);