@privateRemarks
标签类型： 块标签
TSDoc 标准化： 核心
@privateRemarks 标签指定了不适用于公众受众的额外文档内容。作为块标签，@privateRemarks 引入了包含所有注释文本的 TSDoc 部分，直到下一个块标签。
API 提取器将从*.api.json 模型文件省略任何私有备注块，因此它们不会出现在生成的文档中。
使用示例
/**
* The base class for all widgets.
*
* @remarks
* All widget implementations should inherit from this class.
*
* @privateRemarks
* Before making changes to this class, please consult these internal guidelines:
*
* http://contoso-intranet/wiki/WidgetDesignPractices/
*
* @public
*/
export class BaseWidget {
. . .
}