TypeDoc文档工具中的@since标签支持解析

TypeDoc作为TypeScript项目的文档生成工具，在0.26版本中引入了一项重要的标签解析机制改进。这项改进使得开发者能够更清晰地了解哪些JSDoc标签被TypeDoc识别和处理。

标签解析机制的演进

在TypeDoc 0.26版本之前，工具会默默忽略那些它不认识的JSDoc标签。这种处理方式虽然不会导致错误，但开发者无法得知哪些标签实际上没有被处理。新版本中，TypeDoc会明确警告那些未在配置中定义的块级标签，这为开发者提供了更透明的反馈。

@since标签的特殊性

@since是一个常见的JSDoc标签，用于标注某个API或功能是从哪个版本开始引入的。尽管TypeDoc能够通过上下文正确解析并渲染这个标签，但在0.26版本中，它默认不在TypeDoc的认可标签列表中，因此会触发警告信息。

解决方案与配置

对于希望继续使用@since标签的开发者，有两种主要解决方案：

1. 通过配置选项添加：可以在TypeDoc配置文件中使用blockTags选项显式添加@since标签。需要注意的是，这个选项会完全覆盖默认的标签集合，因此需要列出所有需要支持的标签。

2. 使用tsdoc.json定义：更推荐的方式是通过创建tsdoc.json配置文件来定义额外的标签，这种方式不会影响默认的标签集合。

其他标签的处理策略

TypeDoc对不同类型的未识别标签采取了不同的处理策略：

• 对于纯粹提供信息且广泛使用的标签（如@author和@since），TypeDoc团队愿意根据用户需求将其加入默认列表。
• 对于那些在JSDoc中有特定行为但TypeDoc不支持的标签（如@file），则不会加入默认支持，开发者需要使用TypeDoc的等效标签替代。

最佳实践建议

1. 定期检查TypeDoc输出的警告信息，了解哪些标签未被识别
2. 对于常用的信息性标签，考虑通过配置明确声明
3. 了解TypeDoc特有的文档标签（如@packageDocumentation），在适当场景下使用它们替代JSDoc标签
4. 当升级TypeDoc版本时，注意检查标签解析行为的变化

这项改进使得TypeDoc的文档生成过程更加透明和可控，帮助开发者创建更准确和完整的项目文档。