@packageDocumentation

タグタイプ: 修飾子

tsDoc の標準化: core

このタグは、NPM パッケージ全体を説明するドキュメントコメント (パッケージがエクスポートする個別の宣言ではなく) を識別します。API Documenter は @packageDocumentation コンテンツをそのパッケージのページに表示します。

存在する場合、@packageDocumentation コメントは*.d.ts ファイルに格納され、パッケージのエントリポイントとして機能し、そのファイル内で最初に見つかった /** コメントである必要があります。他のタイプのドキュメントコメントでは @packageDocumentation 修飾子を使用しないでください。

@packageDocumentation コメントにリリースタグ (@public や @internal など) を付けることはできません。

@packageDocumentation コメントが見つからない場合、API 抽出器はその API レポートファイルに次のようなメッセージを追加します

// (No @packageDocumentation comment for this package)

使用例

NPMパッケージがwidget-libと呼ばれ、そのメインエントリポイントが./src/index.tsであると仮定します。ソースコードはこのようになります

// Copyright (c) Example Company. All rights reserved. Licensed under the MIT license.

/**
 * A library for building widgets.
 *
 * @remarks
 * The `widget-lib` defines the {@link IWidget} interface and {@link Widget} class,
 * which are used to build widgets.
 *
 * @packageDocumentation
 */

/**
 * Interface implemented by all widgets.
 * @public
 */
export interface IWidget {
  /**
   * Draws the widget on the screen.
   */
  render(): void;
}

/**
 * The standard implementation of the `IWidget` contract.
 * @public
 */
export class Widget implements IWidget {
  /** {@inheritDoc IWidget.render} */
  public render(): void {
    . . .
  }
}

参照​

参照