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中没有找到任何相关信息。

- Ganesh K

Answer 1

除非你将参数标记为可选，否则该参数被视为强制性。你不需要做任何额外的工作。要使你的“somebody”参数强制执行，只需删除方括号：

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

- Louis

---

@Luis，我们如何将参数标记为必填项。假设有 opt1 和 opt2 两个选项，其中一个是必填项。 - mark