@packageDocumentation
| 标准化 | 核心 |
| 语法种类 | 修饰符 |
用法
用于指示描述整个 NPM 包的文档注释（而不是属于该包的单个 API 项）。@packageDocumentation 注释位于*.d.ts 文件中，该文件充当包的入口点，并且它应该是该文件中遇到的第一个 /** 注释。包含 @packageDocumentation 标签的注释绝不应用于描述单个 API 项。
示例
// 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;
}