JsDoc:在函数描述中提及参数

时间:2018-07-10 11:24:11

标签: jsdoc

我正在寻找一种方法来证明(或链接)函数描述中的参数。

这里是一个功能示例

/**
 * @function example
 * @description Compute difference between #arg1 and #arg2
 * @param {string} arg1 - First argument
 * @param {string} arg2 - Second argument
 **/
function example(arg1, arg2) {
    ...
}

如何恰当地提及“#arg1”和“#arg2”?

预先感谢

0 个答案:

没有答案