JSDoc：如何声明内联参数

Question

我无法让 jsdoc 3.5.5 生成内联注释的文档。 请参阅随附的示例：

/**
 * my TestCase Class
 */
class TestCase {

    doesntWorkA(/** String */ str) /** Number */ {
        return 5;
    }

    doesntWorkB(/** @type {String} */ str) /** @type {Number} */ {
        return 5;
    }


    /**
    * @param {String} str
    * @return {Number}
    */
    works(str) {
        return 5;
    }
}

Answer 1

这是一个展示如何内联使用它的示例：

 hooks.run.tap('xxxx',/** @param {WebpackCompilation} compilation */ compilation => {
  ...
 });

Answer 2

@param

标签仅适用于块级别，不适用于内联。您需要

@type

标签。

function toggleButton(
    /**@type {HTMLButtonElement}*/ btnEl,
    /**@type {function():void=}*/ callbackFn
) { }

这是 vscode 的 Intellisense 的样子