根据Yuidoc的文档(在这种情况下似乎等同于JSDOC)有一个@throws标签来记录潜在的抛出错误。
指定方法抛出的错误。@throws标签具有 结构@throws {type}描述。{type}是可选的。
就我而言,有几个检查可以引发错误的函数,因此我想用@throws列出它们。但是您不能拥有一个以上的@throws标签。那么,如何在此标签中放置潜在的错误列表?
我知道它是旧的。但这是第一个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 --
*/
最后我可以自己回答问题:
只要将其列出即可。如果您愿意,可以通过样式标签更改文本的外观 - 只需将其添加到<ul>
* @throws {}
* <ul >
* <li> {exception} Condition 1</li>
* <li> {exception} Condition 2/li>
* <li> {exception} Condition 3</li>
* </ul>