Rush Stackショップブログイベント
メインコンテンツにスキップ

{@link}

タグのタイプ: インライン タグ

TSDoc の標準化: コア

構文

  • {@link DECLARATION_REFERENCE}
  • {@link DECLARATION_REFERENCE | DISPLAY_TEXT}
  • {@link URL}
  • {@link URL | DISPLAY_TEXT}

@link タグは、TSDoc 宣言リファレンス 表記法を使用して指定された、インターネット URL や他の API ドキュメント ページへのハイパーリンクを作成します。DISPLAY_TEXT を省略すると、宣言名または URL アドレスがディスプレイ テキストとして使用されます。

使用方法の例

/**
* The base class for all {@link https://en.wikipedia.org/wiki/Widget | widgets}.
*
* @remarks
* Implements the {@link @microsoft/widget-lib#IWidget} interface. To draw the widget,
* call the {@link BaseWidget.draw | draw() function}.
*
* @public
*/
export class BaseWidget implements IWidget {
/** {@inheritdoc IWidget} */
public draw(): void {
. . .
}

. . .
}

関連項目