[英]How to document multiple errors with @throws in YUIdoc / jsdoc?
根據YUIdoc的文檔(在這種情況下,它等效於jsdoc),有一個@throws標記可以記錄可能引發的錯誤。
指定方法拋出的錯誤。 @throws標簽的結構為@throws {type} description。 {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>
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.