tsdoc-comments

用途：为 TypeScript 公开 API 编写 TSDoc 注释，适用于库代码、类型参数解释、生成文档和 IDE 提示场景。主要能力：以 /** */ 块结构记录短描述、长说明、@param、@returns、@throws、@example、@template、@deprecated、@see、@internal 等标签；强调解释“为什么”而非仅“做什么”，记录异常，随代码更新文档。使用方式：函数用 @param/@returns/@example 描述参数与返回值；泛型用 @template 说明类型参数；类用注释说明职责并提供实例化示例，构造函数与成员分别注释。限制与提醒：资料未提供自动生成文档的工具、安装命令或价格信息；未文档化的公开 API、过时注释、缺失 @template 属常见问题，需避免。