シンタックス

@requires <someModuleName>

概要

@requires タグを使用すると、このコードを使用するのに必要なモジュールをドキュメント化できます。JSDoc コメントには、複数の @require タグを含めることができます。モジュール名は「moduleName」または「module:moduleName」として指定できます。どちらの形式もモジュールとして解釈されます。

JSDoc は、含まれているモジュールの処理を試行しません。ドキュメントにモジュールを含めたい場合は、処理する JavaScript ファイルのリストにモジュールを含める必要があります。

例

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