@privateRemarks

标准化	核心
语法种类	块标签

用法

开始一个附加文档内容的章节，该章节不面向公众。工具必须从 API 参考网站、生成的*.d.ts 文件以及任何其他包含该内容的输出中省略整个章节。

示例

/**
 * 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.
 */

另请参阅

• @remarks 标签