TypeDoc特性引入版本标识标签支持情况及替代方案问询
TypeDoc特性版本标识相关问题解答
是否支持特性引入版本的特定标签?
TypeDoc没有内置专门用于标记特性引入版本的官方标签。
推荐的版本信息添加方式
- 使用自定义
@since标签:在代码注释里添加类似@since x.y.z的自定义标签,TypeDoc会将其作为普通文本渲染到生成的文档中,示例代码:/** * 生成随机ID的工具函数 * @since 1.2.0 */ function generateId(): string { // 实现逻辑 } - 直接整合到描述文本:在函数、类或接口的描述里直接说明版本信息,比如
此特性从v1.2.0版本开始引入,这种方式无需额外配置,直观易懂。 - 借助社区插件扩展:如果需要更规范化的版本展示(比如统一样式、版本筛选),可以使用社区开发的TypeDoc插件来扩展版本标注能力,插件能识别自定义版本标签并生成结构化的文档展示。
内容的提问来源于stack exchange,提问作者vitaly-t
相关产品推荐
相关产品推荐

