Javascript JSDoc:如何声明内联参数
我无法让jsdoc 3.5.5为内联注释生成文档。请参见所附示例:Javascript JSDoc:如何声明内联参数,javascript,jsdoc,jsdoc3,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; }
/**
* 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 => {
...
});
他们的文档语言()暗示它将在描述块中使用:“内联标记,位于块标记或描述的文本中。”