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 {
. . .
}

. . .
}

另请参阅