如何在 YUIdoc / jsdoc 中使用 @throws 记录多个错误?

MBu*_*eld 1 jsdoc yuidoc

根据 YUIdoc 的文档(在本例中似乎相当于 jsdoc),有一个 @throws 标签来记录可能抛出的错误。

指定方法抛出的错误。@throws 标签具有结构@throws {type} 描述。{type} 是可选的。

就我而言,函数中有多个检查可能会引发错误,因此我想用 @throws 列出它们。但您不能拥有多个 @throws 标签。那么如何将可能引发的错误列表放入此标记中呢?

小智 7

我知道它已经很旧了。但由于这是第一个谷歌结果,但没有正确的答案,我将向您展示我在这里找到的解决方案: https: //stackoverflow.com/a/29720979/8466273

只需使用多个@throws

/**
 * -- other definitions --
 * @throws {RangeError}   must be in range 0 to 10
 * @throws {URIError}     wrong URI given
 * -- other definitions --
 */
Run Code Online (Sandbox Code Playgroud)