@throws

Содержание

• Синонимы
• Синтаксис
• Обзор
• Примеры

Синонимы

@exception

Синтаксис

• @throws free-form description
• @throws {<type>}
• @throws {<type>} free-form description

Обзор

Тег @throws позволяет документировать ошибку, которую может сгенерировать функция. В одном комментарии JSDoc вы можете использовать тег @throws более одного раза.

Примеры

/**
 * @throws {InvalidArgumentException}
 */
function foo(x) {}

/**
 * @throws Will throw an error if the argument is null.
 */
function bar(x) {}

/**
 * @throws {DivideByZero} Argument x must be non-zero.
 */
function baz(x) {}