现在在 JSDoc 文档中描述了如何做到这一点,它使用省略号,就像 Closure 文档所做的那样。
@param {...<type>} <argName> <Argument description>
您需要在省略号后面提供一个类型,但您可以使用 a*
来描述接受任何内容,或使用|
分隔多个可接受的类型。在生成的文档中,JSDoc 将这个参数描述为可重复的,就像它将可选参数描述为optional 一样。
在我的测试中,不需要在实际的 javascript 函数定义中使用参数,因此您的实际代码可以只有空括号,即function whatever() { ... }
.
单一类型:
@param {...number} terms Terms to multiply together
任何类型(在下面的示例中,方括号表示items
将被标记为可选和可重复):
@param {...*} [items] - zero or more items to log.
多个类型需要在类型列表周围加上括号,在左括号前加上省略号:
@param {...(Person|string)} attendees - Meeting attendees, listed as either
String names or {@link Person} objects