JSDoc-指定强制参数语法

Question

我正在使用@JSDoc为我的JavaScript库创建文档。我知道如何指示可选参数。像下面

/*
 * @param {string} [somebody] - Somebody's name.
 */
function sayHello(somebody) {
    if (!somebody) {
        somebody = 'John Doe';
    }
    alert('Hello ' + somebody);
}

但我想指出我的API中的某些参数是必需的。如何使用JSDOC进行显示。我从JSDoc tags-param中找不到任何内容

Answer 1

除非您将参数标记为可选，否则该参数将被视为必需参数。您无需执行其他任何操作。要使您的somebody参数成为强制性参数，您只需删除括号：

@param {string} somebody - Somebody's name.