@remarks
| 标准化 | 核心 |
| 语法类型 | 块标签 |
用法
API 条目的主要文档分为简短的“摘要”部分，可选地后跟更详细的“备注”部分。在文档网站上，索引页（例如，显示类的成员）将仅显示简短的摘要，而详细页面（例如，描述单个成员）将显示摘要，然后是备注。 @remarks 块标签结束摘要部分，并开始文档注释的备注部分。
示例
/**
* The summary section should be brief. On a documentation web site,
* it will be shown on a page that lists summaries for many different
* API items. On a detail page for a single item, the summary will be
* shown followed by the remarks section (if any).
*
* @remarks
*
* The main documentation for an API item is separated into a brief
* "summary" section optionally followed by an `@remarks` block containing
* additional details.
*
* @privateRemarks
*
* The `@privateRemarks` tag starts a block of additional commentary that is not meant
* for an external audience. A documentation tool must omit this content from an
* API reference web site. It should also be omitted when generating a normalized
* *.d.ts file.
*/