@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() {}