Rush Stack商城博客活动
跳到主要内容

标准化组

三个“标准化组”用于分类标准 TSDoc 标签,根据兼容文档工具期望的支持级别。它们对应于解析器 API 中的 Standardization 枚举

“核心”组

枚举值:Standardization.Core

“核心”标准化组中的 TSDoc 标签被认为是必不可少的。它们的含义是标准化的,并且每个文档工具都应识别它们。TSDoc 解析器库通常提供专用 API 来访问这些标签。

“扩展”组

枚举值:Standardization.Extended

“扩展”标准化组中的 TSDoc 标签是可选的。文档工具可以选择支持或不支持它们。如果支持,则语法和语义应符合 TSDoc 标准定义。

“酌情”组

枚举值:Standardization.Discretionary

“酌情”标准化组中的 TSDoc 标签是可选的。尽管语法是指定的,但这些标签的语义是特定于实现的(有时很难在不参考特定实现的情况下完全描述)。酌情标签包含在 TSDoc 标准中,以确保如果两个不同的流行工具使用相同的标签名称,开发人员可以期望语法是相同的,并且语义是有些相似的。