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.

JSDoc - 指定必需的参数语法

1 个答案: