2016-06-29 2 views
0

В соответствии с документацией YUIdoc (которая в данном случае эквивалентна jsdoc) существует тег @throws для документирования потенциально заброшенной ошибки.Как документировать несколько ошибок с помощью @throws в YUIdoc/jsdoc?

Задает ошибку, которая вызывает метод. Тег @throws имеет структуру @throws {type}. {Type} не является обязательным.

В моем случае в функции есть несколько проверок, которые могут выдать ошибку, поэтому я хотел бы перечислить их с помощью @throws. Но у вас не может быть более одного тега @throws. Итак, как я могу поместить список потенциально заброшенных ошибок в этот тег?

ответ

0

Наконец я могу ответить на этот вопрос сам:

Просто сделать список. Если вам нравится, вы можете изменить внешний вид текста с помощью тега стиля - просто добавьте его в <ul>

* @throws {} 
* <ul > 
* <li> {exception} Condition 1</li> 
* <li> {exception} Condition 2/li> 
* <li> {exception} Condition 3</li> 
* </ul> 
Смежные вопросы