Question

根据YUIdoc的文档（在这种情况下似乎等同于jsdoc），有一个@throws标记来记录可能抛出的错误。

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

在我的情况下，函数中有几个检查会抛出错误，所以我想用@throws列出它们。但是你不能有多个@throws标签。那么如何在此标记中列出可能抛出的错误列表呢？

Answer 1

我知道它很旧。但这是第一个Google搜索结果，但是没有正确的答案，我将向您展示在这里找到的解决方案：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 --
 */

Answer 2

最后我可以自己回答这个问题：

只需将其列为清单即可。如果您愿意，可以通过样式标记更改文本外观 - 只需将其添加到<ul>

即可

 * @throws {}
 * <ul >
 * <li> {exception}  Condition 1</li>
 * <li> {exception}  Condition 2/li>
 * <li> {exception}  Condition 3</li>
 * </ul>

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

2 个答案: