[英]JSDoc: reference @param of method in another @param
我是使用 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
*/
有没有办法让我在第二个@param
语句中标记单词array
,使其引用第一个@param
?
这只是一个玩具示例,但我希望它使概念清晰。
关于@param
据我所知,没有办法交叉引用参数。 按照这里的建议,您可以使用简单的英语。
作为一种部分解决方案,您可以使用降价的反引号突出param
名称(如描述在这里),例如:
/**
* @param {*} item to test if contained in `array`
*/
在JSDoc
中有一个内联@link
到external
资源的概念,我想在这里会很有用。 您可以在描述中明确指出,例如您谈论的函数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}
*/
如果你有兴趣阅读更多:
没有办法做到这一点。 来源: https : //github.com/jsdoc/jsdoc/issues/1145
我没有看到写入相关参数的可能性(但请参阅 带有属性的参数)。 但是你可以写描述;)
/**
* @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);
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.