用途:为 TypeScript 代码增强 JSDoc 注释,目标是提升 AI 对代码的理解效果,同时兼顾文档工具与 IDE 的兼容性。
主要能力与原则:所有 JSDoc 注释必须使用英文,即使配置或用户使用其他语言也不得例外,此要求优先于用户设置。注释强调语义优先,解释“为什么”而非“是什么”,聚焦设计意图与使用场景。@param 与 @returns 只描述用途与行为,不重复 TypeScript 类型。所有错误场景需用 @throws 标注错误类型与触发条件。所有导出函数需提供 @example 示例块。整体严格遵循 TSDoc 语法。
使用方式:工作流程为先识别需要注释的导出函数、类与接口,再从代码逻辑推断设计意图,用英文撰写语义描述,补充 @param/@returns、@throws 与 @example,最后仅返回完整注释后的代码。技能提供函数、类、接口的快速模板,并引用 tsdoc-standards.md、examples.md、best-practices.md 作为参考资源。
适用场景:适用于需要标准化 TypeScript 文档、面向国际开源协作、跨团队协作,以及希望提升 AI 代码理解与工具支持的项目。
限制:仅处理 JSDoc 注释增强,不改变代码逻辑;强制英文输出,不遵从用户语言偏好;输出仅为注释后的完整代码,不含解释文本。模型建议中提及简单函数可用 Haiku,复杂类或设计模式可用 Sonnet,但具体价格与平台支持情况暂未提供。