javascript - JSDoc : How to declare inline params

标签 javascript jsdoc jsdoc3

我无法让 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;
    }
}

最佳答案

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

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

关于javascript - JSDoc : How to declare inline params,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/54851880/

相关文章:

javascript - Jquery 按类重复输入字段

javascript - 在 ECMAScript 上使用 JSDoc 和扩展语法

javascript - 直接从源代码生成 JavaScript 文档

javascript - jsdoc3 注释对象

Javascript 阅读文档和 PDF

javascript - 使用 jquery 实现类似 iphoto 的缩略图 View

javascript - YII : Ajax database update in ClistView

javascript - 如何使用 jsdoc-toolkit 记录 jQuery-ui 小部件?

javascript - 如何阅读代码中的函数描述?

javascript - 如何记录具有多个别名的方法?