@use JSDoc

シノニム

構文

概要

@throws タグを使用すると、関数がスローする可能性のあるエラーを記述することができます。@throws タグは 1 つの JSDoc コメント内で複数回含めることができます。

例

@throws タグを型と一緒に使用する
/**
 * @throws {InvalidArgumentException}
 */
function foo(x) {}
@throws タグを説明と一緒に使用する
/**
 * @throws Will throw an error if the argument is null.
 */
function bar(x) {}
@throws タグを型と説明と一緒に使用する
/**
 * @throws {DivideByZero} Argument x must be non-zero.
 */
function baz(x) {}