@use JSDoc

语法

@requires <someModuleName>

概述

@requires 标记允许您记录使用此代码所需的模块。JSDoc 注释可以有多个 @require 标记。模块名称可以指定为“moduleName”或“module:moduleName”；两种形式都将解释为模块。

JSDoc 不会尝试处理正在包含的模块。如果您希望模块包含在文档中，则必须在要处理的 JavaScript 文件列表中包含该模块。

示例

使用 @requires 标记
/**
 * This class requires the modules {@link module:xyzcorp/helper} and
 * {@link module:xyzcorp/helper.ShinyWidget#polish}.
 * @class
 * @requires module:xyzcorp/helper
 * @requires xyzcorp/helper.ShinyWidget#polish
 */
function Widgetizer() {}