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.

JSDoc - 指定强制参数语法

JSDoc - specifying mandatory parameter syntax

javascript

doxygen

node.js

jsdoc3