【问题标题】:JSDoc: reference @param of method in another @paramJSDoc:在另一个@param 中引用方法的@param
【发布时间】:2018-10-24 01:57:35
【问题描述】:

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

这只是一个玩具示例,但我希望它能让概念清晰。

【问题讨论】:

    标签: javascript jsdoc jsdoc3


    【解决方案1】:

    交叉引用参数

    关于@param,据我所知,没有办法交叉引用参数。正如here 建议的那样,您可以使用简单的英语。

    作为部分解决方案,您可以使用 markdown 的反引号突出显示 param 名称(如 here 所述),例如:

    /**
     * @param {*} item to test if contained in `array`
     */
    

    旁注:参考外部

    JSDoc 中有一个内联 @linkexternal 资源的概念,我想这在这里会很有用。您可以在描述中明确说明,例如您在谈论Array 的函数includes

    /**
    * 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}
     */
    

    阅读更多

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

    【讨论】:

      【解决方案2】:

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

      【讨论】:

        【解决方案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);
        

        【讨论】:

        • 虽然答案在技术上是正确的,但写得相当混乱,可能是语言问题。我并不挑剔,但我不得不阅读它很多次,直到我得到与我发布的答案相同的内容。
        猜你喜欢
        • 1970-01-01
        • 2015-06-28
        • 1970-01-01
        • 2016-01-14
        • 1970-01-01
        • 1970-01-01
        • 2013-08-11
        • 2018-06-26
        • 2014-03-09
        相关资源
        最近更新 更多