根据 YUIdoc 的文档(在这种情况下似乎等同于 jsdoc),有一个 @throws 标记来记录可能引发的错误。
指定方法抛出的错误。@throws 标签具有结构 @throws {type} 描述。{type} 是可选的。
在我的例子中,函数中有几个检查可能会引发错误,所以我想用@throws 列出它们。但是你不能有多个@throws 标签。那么如何在这个标签中放置一个可能抛出的错误列表呢?
我知道它很旧。但由于这是第一个谷歌结果但没有正确答案,我将向您展示我在这里找到的解决方案: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 --
*/
最后我可以自己回答这个问题:
把它列个清单就行了。如果您愿意,可以通过样式标签更改文本的外观 - 只需将其添加到<ul>
* @throws {}
* <ul >
* <li> {exception} Condition 1</li>
* <li> {exception} Condition 2/li>
* <li> {exception} Condition 3</li>
* </ul>