@privateRemarks
タグタイプ: ブロックタグ
TSDoc 標準化: コア
@privateRemarks タグは、公開を対象としていない追加のドキュメントコンテンツを表します。ブロックタグであるため @privateRemarks はコメントテキストのすべてを含む TSDoc セクションを導入し、それが次のブロックタグに達するまで続けます。
API Extractor はあらゆるプライベート注釈ブロックを*.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 {
. . .
}