代码之家 › 专栏 › 技术社区 › Ganesh K

JSDoc-指定强制参数语法

jsdoc3 jsdoc doxygen node.js javascript

5

Ganesh K · 技术社区 · 8 年前

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

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

我找不到 JSDoc tags-param

1 回复 | 直到 8 年前

1

8

Louis 8 年前

除非将某个参数标记为可选,否则该参数将被视为必需参数。你不需要做额外的事。为了让您的 somebody

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