@use JSDoc

同义词

语法

概述

@throws 标记允许您记录函数可能抛出的错误。您可以在单个 JSDoc 注释中多次包含 @throws 标记。

示例

使用带有类型的 @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) {}