我正在使用 @JSDoc 为我的 javascript 库创建文档。我知道如何指示可选参数。像下面
/*
* @param {string} [somebody] - Somebody's name.
*/
function sayHello(somebody) {
if (!somebody) {
somebody = 'John Doe';
}
alert('Hello ' + somebody);
}
但我想指出我的 API 中的一些参数是强制性的。如何使用 JSDOC 指示它。
我没有找到任何来自
JSDoc tags-param
最佳答案
除非您将参数标记为可选,否则该参数被认为是必需的。您无需执行任何额外操作。要使您的 somebody
参数成为强制性参数,您只需删除括号:
@param {string} somebody - Somebody's name.
关于javascript - JSDoc - 指定强制参数语法,我们在Stack Overflow上找到一个类似的问题:https://stackoverflow.com/questions/39092623/