@packageDocumentation
标签类型：修饰符
TSDoc 标准化：核心
此标签标识描述整个 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 {
. . .
}
}