SuperAPI AI 工具集

method-shorthand-jsdoc

通用与其它

查看项目

更新于 10-15 21:38

技能介绍

用途:解决工厂函数中辅助函数以独立函数形式定义、再被引用进返回对象时,JSDoc 注释在消费者侧(悬停、补全、转到定义)丢失的问题。将只被同级返回方法使用的辅助函数移入返回对象,并改用方法简写(method shorthand)定义。

主要能力:方法简写把 JSDoc 直接挂在 TypeScript 实际看到的属性上,因此悬停返回对象方法可见完整注释;方法简写使用函数语义,this 绑定到该对象,方法间可通过 this.methodName() 互相调用。当公开类型由工厂函数派生(如 export type HeadDoc = ReturnType<typeof createHeadDoc>)时,这是保证悬停、补全与转到定义落在同一成员上的关键。

用法与决策规则:当辅助函数仅被返回方法使用、消费者需要在该方法上看到悬停 JSDoc、且该辅助不在初始化阶段运行时,应移入返回对象。若辅助在 return 之前调用、跨工厂共享,或确实是内部实现不需暴露,则应保持独立(私有 helper)。

限制:箭头函数不适合此模式,因其没有自己的 this,方法间调用会失败;返回对象内应使用方法简写。私有 helper 的 JSDoc 不会对消费者可见,这是符合预期的。资料未提供安装命令、依赖版本或平台支持信息。